AWS SDK pour PHP...AWS SDK pour PHP Manuel du développeur Amazon's trademarks and trade dress may...

AWS SDK pour PHPManuel du développeur

AWS SDK pour PHP: Manuel du développeurCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

AWS SDK pour PHP Manuel du développeur

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's,in any manner that is likely to cause confusion among customers, or in any manner that disparages or discreditsAmazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may notbe affiliated with, connected to, or sponsored by Amazon.


Table of ContentsAWS SDK pour PHP .......................................................................................................................... 1

Mise en route ............................................................................................................................ 1Guides du kit SDK ...................................................................................................................... 2Fonctions spécifiques aux services ................................................................................................ 2Exemples .................................................................................................................................. 2Référence .................................................................................................................................. 2Documentation sur les API ........................................................................................................... 3

Mise en route .................................................................................................................................... 4Prérequis ................................................................................................................................... 4

Prérequis ........................................................................................................................... 4Recommandations .............................................................................................................. 4Test de compatibilité ........................................................................................................... 5

Installation du kit SDK ................................................................................................................. 5Installer AWS SDK for PHP en tant que dépendance via Composer ........................................... 5Installation à l'aide du phar prépackagé ................................................................................. 6Installation à l'aide du fichier ZIP .......................................................................................... 7

Utilisation de base ...................................................................................................................... 7Prérequis ........................................................................................................................... 7Inclusion du kit SDK dans votre code .................................................................................... 7Résumé de l'utilisation ......................................................................................................... 7Création d'un client ............................................................................................................. 8Utilisation de la classe Sdk .................................................................................................. 8Exécution d'opérations de service ......................................................................................... 9Requêtes asynchrones ...................................................................................................... 10Utilisation des objets de résultat .......................................................................................... 11Gestion des erreurs .......................................................................................................... 12

Mise à niveau depuis la version 2 ............................................................................................... 14Introduction ...................................................................................................................... 14Nouveautés de la version 3 ................................................................................................ 14Changements par rapport à la version 2 ............................................................................... 15Comparaison d'exemples de code à partir de deux versions du kit SDK ..................................... 21

Configuration du kit SDK .................................................................................................................... 24Options de configuration ............................................................................................................ 24

api_provider ..................................................................................................................... 25credentials ....................................................................................................................... 25debug .............................................................................................................................. 26stats ................................................................................................................................ 28endpoint .......................................................................................................................... 29endpoint_provider .............................................................................................................. 29endpoint_discovery ............................................................................................................ 30handler ............................................................................................................................ 31http ................................................................................................................................. 32http_handler ..................................................................................................................... 37profile .............................................................................................................................. 38région .............................................................................................................................. 39retries .............................................................................................................................. 39scheme ........................................................................................................................... 39web ................................................................................................................................ 40signature_provider ............................................................................................................. 40signature_version .............................................................................................................. 40ua_append ....................................................................................................................... 41valider ............................................................................................................................. 41Version ............................................................................................................................ 42

Définition des informations d'identification ..................................................................................... 42

iii


Utilisation de la chaîne de fournisseur d'informations d'identification par défaut ............................ 43Autres façons d'ajouter des informations d'identification .......................................................... 43Utilisation des informations d’identification des variables d’environnement ................................. 44Utilisation du fichier d’informations d’identification AWS et des profils d’informationsd’identification ................................................................................................................... 45Assumer un rôle IAM ........................................................................................................ 47Utilisation d’un fournisseur d’informations d’identification ........................................................ 50Utilisation des informations d’identification temporaires d’AWS STS ......................................... 57Informations d’identification codées en dur ............................................................................ 59Création de clients anonymes ............................................................................................ 59

Objets de commande ................................................................................................................ 60Utilisation de commandes implicite ...................................................................................... 60Paramètres de commande ................................................................................................. 60Création d'objets de commande .......................................................................................... 61Commande HandlerList ...................................................................................................... 61CommandPool .................................................................................................................. 62

Promesses ............................................................................................................................... 65Qu'est-ce qu'une promesse ? .............................................................................................. 65Promesses dans le kit SDK ................................................................................................ 65Chaînage de promesses .................................................................................................... 67Attente des promesses ...................................................................................................... 67Annulation des promesses ................................................................................................. 68Combinaison des promesses .............................................................................................. 68

Gestionnaires et intergiciels ........................................................................................................ 70Gestionnaires ................................................................................................................... 70Intergiciel ......................................................................................................................... 71Création de gestionnaires personnalisés ............................................................................... 76

Streams ................................................................................................................................... 77Décorateurs de flux ........................................................................................................... 77

Paginateurs .............................................................................................................................. 80Objets de programme de pagination .................................................................................... 81Énumération de données à partir des résultats ...................................................................... 81Pagination asynchrone ....................................................................................................... 82

Programmes d'attente ................................................................................................................ 82Configuration du programme d'attente .................................................................................. 83Attente asynchrone ........................................................................................................... 84

Expressions JMESPath .............................................................................................................. 85Extraire des données à partir de résultats ............................................................................. 85Extraire des données à partir de programmes de pagination .................................................... 88

SDK Metrics ............................................................................................................................. 89Autoriser les métriques du kit SDK ...................................................................................... 89Configurer les métriques du kit SDK .................................................................................... 92Définitions de SDK Metrics ................................................................................................. 96

Utilisation des services AWS .............................................................................................................. 98AWS Cloud9 ............................................................................................................................. 98

Étape 1 : Configurer votre compte AWS pour utiliser AWS Cloud9 ............................................ 98Étape 2 : Configurer votre environnement de développement AWS Cloud9 ................................. 99Étape 3 : Configurer le kit AWS SDK for PHP ....................................................................... 99Étape 4 : Télécharger l’exemple de code .............................................................................. 99Étape 5 : Exécuter et déboguer l’exemple de code ............................................................... 100

Amazon DynamoDB ................................................................................................................ 100Utilisation de base ........................................................................................................... 100Configuration .................................................................................................................. 101Tarification ..................................................................................................................... 102Verrouillage de la session ................................................................................................ 103Nettoyage de la mémoire ................................................................................................. 103Bonnes pratiques ............................................................................................................ 104

iv


Autorisations IAM nécessaires ........................................................................................... 105Client sur plusieurs régions Amazon S3 ..................................................................................... 105

Utilisation de base ........................................................................................................... 100Cache de région d'un compartiment ................................................................................... 106

Encapsuleur de flux Amazon S3 ................................................................................................ 106Téléchargement des données ........................................................................................... 107Téléchargement des données ........................................................................................... 108Modes fopen .................................................................................................................. 108Autres fonctions d'objet .................................................................................................... 109Utilisation des compartiments ............................................................................................ 110Options de contexte de flux ................................................................................................ 94

Gestionnaire de transferts Amazon S3 ....................................................................................... 111Chargement d'un répertoire local vers Amazon S3 ............................................................... 111Téléchargement d'un compartiment Amazon S3 ................................................................... 112Configuration .................................................................................................................. 101Options de transfert ......................................................................................................... 113Transferts asynchrones .................................................................................................... 113Personnalisation des commandes du gestionnaire de transfert ............................................... 114

Chiffrement côté client Amazon S3 ............................................................................................ 114Setup ............................................................................................................................ 115Chiffrement ..................................................................................................................... 115Déchiffrement ................................................................................................................. 116Configuration de chiffrement ............................................................................................. 116Stratégies de métadonnées .............................................................................................. 117Chargements partitionnés ................................................................................................. 117

Exemples de code .......................................................................................................................... 119Informations d'identification ......................................................................................................... 25Exemples Amazon CloudFront .................................................................................................. 119

Gestion des distributions CloudFront .................................................................................. 120Gestion des invalidations CloudFront .................................................................................. 127Signature d'URL CloudFront ............................................................................................. 130

Amazon CloudSearch ............................................................................................................... 134Informations d'identification ................................................................................................. 25Signer une demande de domaine CSlong ........................................................................... 135

Exemples Amazon CloudWatch ................................................................................................. 135Informations d'identification ................................................................................................. 25Utilisation des alarmes Amazon CloudWatch ....................................................................... 136Obtention de métriques à partir d’Amazon CloudWatch ......................................................... 138Publication de métriques personnalisées dans Amazon CloudWatch ....................................... 141Envoi d’événements à Amazon CloudWatch Events ............................................................. 142Utilisation d’actions d’alarme avec des alarmes Amazon CloudWatch ...................................... 145

Exemples Amazon EC2 ........................................................................................................... 146Informations d'identification ................................................................................................. 25Gestion des instances Amazon EC2 .................................................................................. 147Utilisation des adresses IP Elastic ..................................................................................... 149Utilisation des régions et des zones de disponibilité .............................................................. 151Utilisation des paires de clés ............................................................................................ 153Utilisation des groupes de sécurité .................................................................................... 155

Amazon Elasticsearch .............................................................................................................. 157Informations d'identification ................................................................................................. 25Signature d'une demande Amazon ES ............................................................................... 157

Exemples AWS Identity and Access Management (IAM) ............................................................... 158Informations d'identification ................................................................................................. 25Gestion des clés d’accès IAM ........................................................................................... 159Gestion des utilisateurs IAM ............................................................................................. 162Utilisation des alias de compte IAM ................................................................................... 165Utilisation des stratégies IAM ............................................................................................ 167

v


Utilisation des certificats de serveur IAM ............................................................................. 174AWS Key Management Service ................................................................................................. 176

Utilisation de clés ............................................................................................................ 177Chiffrement et déchiffrement des clés de données ................................................................ 181Utilisation de stratégies de clé .......................................................................................... 184Utilisation d'octrois ........................................................................................................... 187Utilisation des alias ......................................................................................................... 190

Exemples Amazon Kinesis ........................................................................................................ 193Kinesis Data Streams ....................................................................................................... 194Partitions Kinesis ............................................................................................................. 198Flux de diffusion Kinesis Data Firehose .............................................................................. 200

AWS Elemental MediaConvert ................................................................................................... 206Informations d'identification ................................................................................................. 25Obtention du point de terminaison propre à votre compte ...................................................... 207Création et gestion de tâches ........................................................................................... 208

Exemples Amazon S3 .............................................................................................................. 213Informations d'identification ................................................................................................. 25Création et utilisation de compartiments Amazon S3 ............................................................. 214Gestion des autorisations d’accès aux compartiments Amazon S3 .......................................... 216Configuration de compartiments Amazon S3 ....................................................................... 218Chargements partitionnés Amazon S3 ................................................................................ 220Création de POST pré-signés S3 ...................................................................................... 227URL pré-signées Amazon S3 ............................................................................................ 228Utilisation d’un compartiment Amazon S3 en tant qu’hôte Web statique ................................... 230Utilisation de stratégies de compartiment Amazon S3 ........................................................... 231

Amazon Secrets Manager ........................................................................................................ 233Informations d'identification ................................................................................................. 25Créer un secret dans Secrets Manager .............................................................................. 233Récupérer un secret à partir d'Secrets Manager .................................................................. 234Répertorier les secrets stockés dans Secrets Manager .......................................................... 235Obtenir les détails d'un secret ........................................................................................... 236Mettre à jour la valeur d'un secret ..................................................................................... 236Configurer la rotation de la valeur d'un secret dans Secrets Manager ...................................... 237Supprimer un secret d'Secrets Manager ............................................................................. 239Informations connexes ..................................................................................................... 239

Exemples Amazon SES ........................................................................................................... 240Vérification des adresses e-mail ........................................................................................ 240Utilisation des modèles d’e-mail ........................................................................................ 245Gestion des filtres d’e-mails .............................................................................................. 249Utilisation des règles d’e-mail ............................................................................................ 252Surveiller votre activité d’envoi .......................................................................................... 258Autoriser les expéditeurs .................................................................................................. 259

Exemples Amazon SNS ........................................................................................................... 263Gestion des rubriques ...................................................................................................... 264Gestion des abonnements ................................................................................................ 267Envoi de messages SMS Amazon ..................................................................................... 273

Exemples Amazon SQS ........................................................................................................... 277Activation de l’attente active de longue durée ...................................................................... 277Gestion du délai de visibilité ............................................................................................. 280Envoi et réception de messages ........................................................................................ 281Utilisation des files d’attente de lettres mortes ..................................................................... 283Utilisation de files d’attente ............................................................................................... 284

Sécurité ......................................................................................................................................... 288Protection des données ............................................................................................................ 288Gestion des identités et des accès ............................................................................................ 289Validation de la conformité ....................................................................................................... 289Résilience .............................................................................................................................. 290

vi


Sécurité de l'infrastructure ........................................................................................................ 290FAQ .............................................................................................................................................. 292

Quelles méthodes sont disponibles sur un client ? ........................................................................ 292Que dois-je faire en cas d'erreur de certificat cURL SSL ? ............................................................. 292Quelles versions d'API sont disponibles pour un client ? ................................................................ 292Quelles versions de région sont disponibles pour un client ? .......................................................... 293Pourquoi ne puis-je pas charger ou télécharger des fichiers de plus de 2 Go ? .................................. 293Comment savoir quelles données sont envoyées sur le réseau ? .................................................... 293Comment puis-je définir des en-têtes arbitraires sur une requête ? .................................................. 293Comment puis-je signer une requête arbitraire ? .......................................................................... 294Comment puis-je modifier une commande avant de l'envoyer ? ...................................................... 294Qu'est-ce qu'une CredentialsException ? ..................................................................................... 294Le kit AWS SDK for PHP fonctionne-t-il sur HHVM ? .................................................................... 294Comment désactiver SSL ? ...................................................................................................... 295Que dois-je faire face à une « erreur d'analyse » ? ....................................................................... 295Pourquoi le client Amazon S3 décompresse-t-il les fichiers gzipped ? .............................................. 295Comment désactiver la signature du corps dans Amazon S3 ? ....................................................... 295Comment le schéma de nouvelle tentative est-il géré dans le kit AWS SDK for PHP ? ........................ 296Comment gérer les exceptions avec des codes d'erreur ? ............................................................. 296

Glossaire ....................................................................................................................................... 298Ressources supplémentaires ........................................................................................................... 300

Forum PHP SDK ..................................................................................................................... 300Kit SDK PHP v3 et Manuel du développeur sur GitHub ................................................................. 300PHP SDK sur Gitter ................................................................................................................ 300

Historique du document ................................................................................................................... 301

vii

AWS SDK pour PHP Manuel du développeurMise en route

Présentation du kit AWS SDK forPHP version 3

Le kit AWS SDK for PHP version 3 permet aux développeurs PHP d’utiliser Amazon Web Services dansleur code PHP et de concevoir des applications et des logiciels robustes à l’aide de services tels queAmazon S3, Amazon DynamoDB, S3 Glacier, etc. Vous pouvez faire vos premiers pas en quelquesminutes en installant le kit SDK via Composer (en demandant le package aws/aws-sdk-php) ou entéléchargeant le fichier autonome aws.zip ou aws.phar.

Tous les services ne sont pas immédiatement disponibles dans le kit SDK. Pour savoir quels servicessont actuellement pris en charge par le kit AWS SDK for PHP, recherchez le nom du service et la versionde l’API. Pour plus d’informations sur le kit AWS SDK for PHP version 3 sur GitHub, consultez la sectionrelative aux ressources supplémentaires (p. 300).

Liens externes : Documentation sur l’API | GitHub | Gitter | Blog | Forum | Packagist

Note

Si vous migrez le code de votre projet pour passer de la version 2 du kit SDK à la version 3, veillezà lire la section Mise à niveau depuis la version 2 du kit AWS SDK pour PHP (p. 14).

Mise en route• Exigences et recommandations pour le kit AWS SDK pour PHP version 3 (p. 4)• Installation du kit AWS SDK pour PHP version 3 (p. 5)• Modèles d’utilisation de base du kit AWS SDK pour PHP version 3 (p. 7)• Mise à niveau depuis la version 2 du kit AWS SDK pour PHP (p. 14)

1

https://aws.amazon.com/

https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.zip

https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.phar

https://docs.aws.amazon.com/aws-sdk-php/v3/api/index.html



https://github.com/aws/aws-sdk-php

https://gitter.im/aws/aws-sdk-php

http://aws.amazon.com/blogs/developer/category/php/

https://forums.aws.amazon.com/forum.jspa?forumID=80

https://packagist.org/packages/aws/aws-sdk-php

AWS SDK pour PHP Manuel du développeurGuides du kit SDK

Guides du kit SDK• Configuration du kit AWS SDK pour PHP (p. 24)• Informations d’identification pour le kit AWS SDK pour PHP (p. 42)• Objets de commande dans le kit AWS SDK pour PHP (p. 60)• Promesses dans le kit AWS SDK pour PHP (p. 65)• Gestionnaires et intergiciels dans le kit AWS SDK pour PHP (p. 70)• Flux dans le kit AWS SDK pour PHP (p. 77)• Programmes de pagination dans le kit AWS SDK pour PHP (p. 80)• Programmes d’attente dans le kit AWS SDK pour PHP (p. 82)• Expressions JMESPath dans le kit AWS SDK pour PHP (p. 85)• Métriques du kit SDK (p. 89)

Fonctions spécifiques aux services• Utilisation d’AWS Cloud9 avec le kit AWS SDK pour PHP (p. 98)• Utilisation du gestionnaire de session DynamoDB avec le kit AWS SDK pour PHP (p. 100)• Client sur plusieurs régions Amazon S3 (p. 105)• Encapsuleur de flux Amazon S3 (p. 106)• Gestionnaire de transferts Amazon S3 (p. 111)• Chiffrement côté client Amazon S3 (p. 114)

Exemples• Amazon CloudFront (p. 119)• Signature des requêtes de domaine Amazon CloudSearch personnalisées (p. 134)• Exemples Amazon CloudWatch (p. 135)• Amazon EC2 (p. 146)• Signature des requêtes de recherche Amazon Elasticsearch Service (p. 157)• Exemples AWS Identity and Access Management (p. 158)• AWS Key Management Service (p. 176)• Exemples Amazon Kinesis (p. 193)• Exemples AWS Elemental MediaConvert (p. 206)• Exemples Amazon S3 (p. 213)• Exemples Amazon Simple Email Services (p. 240)• Exemples Amazon SNS (p. 263)• Exemples Amazon SQS (p. 277)

Pour obtenir des exemples supplémentaires, consultez le catalogue d'exemples de code AWS.

Référence• FAQ (p. 292)

2

https://docs.aws.amazon.com/code-samples/latest/catalog

AWS SDK pour PHP Manuel du développeurDocumentation sur les API

• Glossaire (p. 298)• Contribution au kit SDK• Documentation Guzzle

Soumettre les problèmes sur GitHub :

• Soumettre les problèmes de documentation• Signaler un bogue ou demander une fonctionnalité

Documentation sur les APILa documentation sur l’API pour le kit SDK est disponible à l’adresse http://docs.aws.amazon.com/aws-sdk-php/v3/api/.

3

https://github.com/aws/aws-sdk-php/blob/master/CONTRIBUTING.md

http://guzzlephp.org

https://github.com/awsdocs/aws-php-developers-guide/issues

https://github.com/aws/aws-sdk-php/issues/new/choose

https://docs.aws.amazon.com/aws-sdk-php/v3/api/

https://docs.aws.amazon.com/aws-sdk-php/v3/api/

AWS SDK pour PHP Manuel du développeurPrérequis

Mise en route avec le kit AWS SDKfor PHP version 3

Ce chapitre a pour but de vous aider à vous familiariser avec le kit AWS SDK for PHP version 3.

Rubriques• Exigences et recommandations pour le kit AWS SDK for PHP version 3 (p. 4)• Installation du kit AWS SDK for PHP version 3 (p. 5)• Modèles d’utilisation de base du kit AWS SDK for PHP version 3 (p. 7)• Mise à niveau depuis la version 2 du kit AWS SDK for PHP (p. 14)

Exigences et recommandations pour le kit AWSSDK for PHP version 3

Afin d'obtenir les meilleurs résultats avec le kit AWS SDK for PHP, assurez-vous que votre environnementprend en charge les exigences et recommandations suivantes.

PrérequisPour utiliser le kit AWS SDK for PHP, vous devez utiliser PHP version 5.5.0 ou version ultérieure. Si vousdevez signer des URL Amazon CloudWatch privées, vous devez également disposer de l’extension PHPOpenSSL.

RecommandationsEn plus de la configuration minimale requise, nous vous recommandons d'installer, de désinstaller etd'utiliser les éléments suivants.

Installez cURL 7.16.2 ou une version ultérieure Utilisez une version récente de cURL compiléeavec OpenSSL/NSS et zlib. Si cURL n'est pasinstallé sur votre système et si vous ne configurezpas de gestionnaire HTTP personnalisé pour votreclient, le kit SDK utilisera l'encapsuleur de fluxPHP.

Utilisez OPCache Utilisez l'extension OPcache afin d'améliorer lesperformances PHP en stockant un bytecode descript précompilé dans une mémoire partagée.Ainsi, vous n'avez plus besoin de PHP pourcharger et analyser des scripts sur chaque requête.Cette extension est généralement activée pardéfaut.

Lorsque vous exécutez Amazon Linux, vous devezinstaller le package php56-opcache ou php55-opcache pour pouvoir utiliser l'extension OPCache.

Désinstallez Xdebug Xdebug peut vous aider à identifier les goulotsd'étranglement au niveau des performances.

4

http://php.net/manual/en/book.openssl.php

http://php.net/manual/en/book.openssl.php

http://php.net/manual/en/book.curl.php

http://php.net/manual/en/book.opcache.php

http://xdebug.org/

AWS SDK pour PHP Manuel du développeurTest de compatibilité

Toutefois, si les performances sont essentiellespour votre application, n'installez pas l'extensionXdebug dans votre environnement de production.Le chargement de cette extension ralentitconsidérablement les performances du kit SDK.

Utilisez un chargeur automatique classmapComposer

Les chargeurs automatiques chargent les classesrequises par un script PHP. Composer génèreun chargeur automatique capable de chargerautomatiquement les scripts PHP de votreapplication ainsi que tous les autres scripts PHPqu'elle requiert, y compris le kit AWS SDK for PHP.

Nous vous recommandons d'utiliser unchargeur automatique classmap pour lesenvironnements de production afin d'améliorerleurs performances. Vous pouvez générer unchargeur automatique classmap en spécifiantl'option -o ou ==optimize-autoloader dans lacommande d'installation de Composer.

Test de compatibilitéExécutez le fichier compatibility-test.php dans le kit SDK afin de vérifier que votre système peutexécuter ce dernier. En plus de vérifier la configuration système minimale requise pour le kit SDK, le testde compatibilité contrôle certains paramètres facultatifs et propose des recommandations qui peuventvous aider à améliorer les performances. Le test de compatibilité génère des résultats dans la ligne decommande ou dans un navigateur web. Si vous passez en revue les résultats du test dans un navigateur,les vérifications réussies s'affichent en vert, les avertissements s'affichent en violet et les échecs s'affichenten rouge. Lorsque vous exécutez le test à partir de la ligne de commande, chaque résultat d'un contrôles'affiche sur une ligne distincte.

Lorsque vous signalez un problème concernant le kit SDK, pensez à partager le résultat du test decompatibilité afin de faciliter l'identification de la cause sous-jacente.

Installation du kit AWS SDK for PHP version 3Vous pouvez installer le kit AWS SDK for PHP version 3 :

• En tant que dépendance via Composer• En tant que phar prépackagé du kit SDK• En tant que fichier ZIP du kit SDK

Avant d’installer AWS SDK for PHP la version 3, vérifiez que votre environnement utilise PHP version 5.5ou ultérieure. En savoir plus sur les exigences et recommandations relatives à l’environnement (p. 4)

Installer AWS SDK for PHP en tant que dépendancevia ComposerComposer est la solution recommandée pour installer le kit AWS SDK for PHP. Composer est un outil PHPqui gère et installe les dépendances de votre projet.

5

http://getcomposer.org


AWS SDK pour PHP Manuel du développeurInstallation à l'aide du phar prépackagé

Pour en savoir plus sur l’installation de Composer, la configuration du chargement automatique et lerespect d’autres bonnes pratiques pour définir des dépendances, rendez-vous sur getcomposer.org.

Installation de ComposerSi Composer n’est pas déjà dans votre projet, téléchargez et installez Composer.

Pour Windows, téléchargez et exécutez Composer-Setup.exe.

Pour Linux, suivez l’installation de ligne de commande sur la page de téléchargement de Composer.

Ajouter AWS SDK for PHP en tant que dépendance viaComposerSi le Composer est déjà installé globalement sur votre système, exécutez la commande suivante dans lerépertoire de base de votre projet pour installer AWS SDK for PHP en tant que dépendance :

composer require aws/aws-sdk-php

Dans le cas contraire, saisissez cette commande Composer pour installer la version la plus récente du kitAWS SDK for PHP en tant que dépendance.

php -d memory_limit=-1 composer.phar require aws/aws-sdk-php

Ajouter un chargeur automatique à vos scripts phpPour utiliser les kits AWS SDK for PHP dans vos scripts, incluez le chargeur automatique dans vos scriptsen procédant comme suit.

<?php require '/path/to/vendor/autoload.php';?>

Installation à l'aide du phar prépackagéChaque version du kit AWS SDK for PHP comprend un phar (archive PHP) prépackagé contenanttoutes les classes et dépendances dont vous avez besoin pour exécuter le kit SDK. De plus, le pharenregistre automatiquement un chargeur automatique de classe pour le kit AWS SDK for PHP et toutes sesdépendances.

Vous pouvez télécharger le phar packagé et l’inclure dans vos scripts.

<?php require '/path/to/aws.phar';?>

Note

L'utilisation de PHP avec le correctif Suhosin n'est pas recommandée, mais elle est courantesur les distributions Ubuntu et Debian. Dans ce cas, il se peut que vous ayez besoin d'activerl'utilisation des phars dans le suhosin.ini. Si vous ne le faites pas, l'ajout d'un fichier phar à votrecode provoquera un échec silencieux. Pour modifier suhosin.ini, ajoutez la ligne suivante.

suhosin.executor.include.whitelist = phar

6


http://getcomposer.org/download

https://getcomposer.org/Composer-Setup.exe

http://getcomposer.org/download

https://getcomposer.org/doc/00-intro.md#globally

https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.phar

AWS SDK pour PHP Manuel du développeurInstallation à l'aide du fichier ZIP

Installation à l'aide du fichier ZIPLe kit AWS SDK for PHP comprend un fichier ZIP contenant toutes les classes et dépendances dont vousavez besoin pour exécuter le kit SDK. De plus, le fichier ZIP inclut un chargeur automatique de classe pourle kit AWS SDK for PHP et ses dépendances.

Pour installer le kit SDK, téléchargez le fichier .zip, puis extrayez-le dans votre projet à l’emplacement devotre choix. Incluez ensuite le chargeur automatique dans vos scripts, comme suit.

<?php require '/path/to/aws-autoloader.php';?>

Modèles d’utilisation de base du kit AWS SDK forPHP version 3

Cette rubrique se concentre sur les modèles d'utilisation de base du kit AWS SDK for PHP.

Prérequis• Téléchargez et installez le kit SDK (p. 5).• Récupérez vos clés d’accès AWS.

Inclusion du kit SDK dans votre codeQuelle que soit la méthode que vous avez utilisée pour installer le kit SDK, vous pouvez inclure ce dernierdans votre code à l'aide d'une seule déclaration require. Consultez le tableau suivant pour savoir quelcode PHP convient le mieux à votre installation technique. Remplacez toutes les occurrences de /path/to/ par le chemin d'accès sur votre système.

Technique d'installation Déclaration require

Composer require '/path/to/vendor/autoload.php';

phar require '/path/to/aws.phar';

ZIP require '/path/to/aws-autoloader.php';

Les exemples présentés dans cette rubrique reposent sur la méthode d'installation Composer. Si vousutilisez une autre méthode d'installation, vous pouvez revenir à cette section pour trouver le code requireapproprié à utiliser.

Résumé de l'utilisationPour utiliser le kit SDK afin d’interagir avec un service AWS, instanciez un objet Client. Les objets clientsont associés à des méthodes qui correspondent chacune à des opérations de l'API du service. Pourexécuter une opération spécifique, appelez sa méthode correspondante. Cette méthode renvoie un objetResult de type tableau en cas de réussite ou lève une Exception en cas d’échec.

7

https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.zip

https://aws.amazon.com/developers/access-keys/

AWS SDK pour PHP Manuel du développeurCréation d'un client

Création d'un clientVous pouvez créer un client en transmettant un tableau associatif d'options au constructeur d'un client.

Importations

require 'vendor/autoload.php';

use Aws\S3\S3Client;

use Aws\Exception\AwsException;

Exemple de code

//Create a S3Client$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-east-2']);

Notez que nous n’avons pas explicitement fourni d’informations d’identification au client. En effet, le kitSDK doit détecter les informations d'identification à partir de variables d'environnement (p. 44) (viaAWS_ACCESS_KEY_ID et AWS_SECRET_ACCESS_KEY), d'un fichier INI d'informations d'identificationAWS (p. 45) dans votre répertoire HOME, d'informations d’identification de profil d'instance (p. 47)AWS Identity and Access Management (IAM) ou de fournisseurs d’informations d'identification (p. 50).

Toutes les options de configuration générales du client sont détaillées dans le guide deconfiguration (p. 24). Les options fournies peuvent varier selon le type de client que vous créez. Cesoptions de configuration client personnalisées sont décrites dans la documentation sur l’API de chaqueclient.

Utilisation de la classe SdkLa classe Aws\Sdk fonctionne comme une fabrique de clients. Elle permet de gérer des options deconfiguration partagées sur plusieurs clients. La classe Aws\Sdk peut recevoir les mêmes options qu'unconstructeur client spécifique. Ces options sont ensuite appliquées à chaque constructeur client.

Importations




Exemple de code

// The same options that can be provided to a specific client constructor can also be supplied to the Aws\Sdk class.// Use the us-west-2 region and latest version of each client.$sharedConfig = [ 'region' => 'us-west-2', 'version' => 'latest'];

// Create an SDK class used to share configuration across clients.$sdk = new Aws\Sdk($sharedConfig);

8

https://docs.aws.amazon.com/aws-sdk-php/latest/

AWS SDK pour PHP Manuel du développeurExécution d'opérations de service

// Create an Amazon S3 client using the shared configuration data.$client = $sdk->createS3();

Les options partagées entre tous les clients sont placées dans des paires clé-valeur au niveau racine. Desdonnées de configuration spécifiques au service peuvent être fournies dans une clé identique à l'espace denoms d'un service (par exemple, « S3 », « DynamoDb », etc.).

$sdk = new Aws\Sdk([ 'region' => 'us-west-2', 'version' => 'latest', 'DynamoDb' => [ 'region' => 'eu-central-1' ]]);

// Creating an Amazon DynamoDb client will use the "eu-central-1" AWS Region$client = $sdk->createDynamoDb();

Les valeurs de configuration spécifiques au service comprennent les valeurs spécifiques au service et lesvaleurs de niveau racine (les valeurs spécifiques au service sont fusionnées de manière superficielle dansles valeurs de niveau racine).

Note

Nous vous recommandons vivement d'utiliser la classe Sdk pour créer des clients si vous utilisezplusieurs instances client dans votre application. La classe Sdk utilise automatiquement le mêmeclient HTTP pour chaque client de kit SDK. Ainsi, des clients de kit SDK pour différents servicespeuvent lancer des requêtes HTTP non bloquantes. Si les clients de kit SDK n'utilisent pas lemême client HTTP, les demandes HTTP envoyées par le client de kit SDK peuvent bloquerl'orchestration des promesses entre les services.

Exécution d'opérations de serviceVous pouvez exécuter une opération de service en appelant la méthode du même nom sur un objetclient. Par exemple, pour effectuer l'opération Amazon S3 PutObject, vous devez appeler la méthode Aws\S3\S3Client::putObject().

Importations



Exemple de code

// Use the us-east-2 region and latest version of each client.$sharedConfig = [ 'profile' => 'default', 'region' => 'us-east-2', 'version' => 'latest'];


// Use an Aws\Sdk class to create the S3Client object.$s3Client = $sdk->createS3();

9

https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html

AWS SDK pour PHP Manuel du développeurRequêtes asynchrones

// Send a PutObject request and get the result object.$result = $s3Client->putObject([ 'Bucket' => 'my-bucket', 'Key' => 'my-key', 'Body' => 'this is the body!']);

// Download the contents of the object.$result = $s3Client->getObject([ 'Bucket' => 'my-bucket', 'Key' => 'my-key']);

// Print the body of the result by indexing into the result object.echo $result['Body'];

Les opérations disponibles pour un client, ainsi que la structure de l'entrée et de la sortie, sont définies aumoment de l'exécution en fonction d'un fichier de description du service. Lorsque vous créez un client, vousdevez spécifier une version (par exemple, « 2006-03-01 » ou « latest »). Le kit SDK détecte le fichier deconfiguration correspondant en fonction de la version fournie.

Toutes les méthodes d'opération telles que putObject() acceptent un seul argument : un tableauassociatif qui représente les paramètres de l'opération. La structure de ce tableau (et la structure de l'objetde résultat) est définie pour chaque opération dans la documentation sur l'API du SDK (par exemple,consultez les documents sur l'API pour de plus amples informations sur l'opération putObject).

Options du gestionnaire HTTPVous pouvez également ajuster la manière dont le gestionnaire HTTP sous-jacent exécute la requête àl'aide du paramètre spécial @http. Vous pouvez inclure dans le paramètre @http les mêmes options quecelles définies lors de l'instanciation du client à l'aide de l'option client « http » (p. 32).

// Send the request through a proxy$result = $s3Client->putObject([ 'Bucket' => 'my-bucket', 'Key' => 'my-key', 'Body' => 'this is the body!', '@http' => [ 'proxy' => 'http://192.168.16.1:10' ]]);

Requêtes asynchronesVous pouvez envoyer des commandes simultanément à l'aide des fonctions asynchrones du kit SDK.Vous pouvez envoyer des requêtes de manière asynchrone en ajoutant Async à la fin du nom d'uneopération. Cette méthode lance la requête et renvoie une promesse. La promesse est exécutée avec l'objetde résultat en cas de réussite ou rejetée avec une exception en cas d'échec. Cela vous permet de créerplusieurs promesses et de leur faire envoyer des requêtes HTTP simultanément lorsque le gestionnaireHTTP sous-jacent transfère les requêtes.

Importations

require 'vendor/autoload.php';use Aws\S3\S3Client;use Aws\Exception\AwsException;

10

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-s3-2006-03-01.html#putobject

AWS SDK pour PHP Manuel du développeurUtilisation des objets de résultat

Exemple de code

// Create an SDK class used to share configuration across clients.$sdk = new Aws\Sdk([ 'region' => 'us-west-2', 'version' => 'latest']);// Use an Aws\Sdk class to create the S3Client object.$s3Client = $sdk->createS3();//Listing all S3 Bucket$CompleteSynchronously = $s3Client->listBucketsAsync();// Block until the result is ready.$CompleteSynchronously = $CompleteSynchronously->wait();

Vous pouvez forcer une promesse à exécuter les opérations de manière synchrone à l'aide de la méthodewait de la promesse. L'exécution forcée de la promesse « débloque » l'état de la promesse par défaut : lerésultat de la promesse est renvoyé ou l'exception rencontrée est levée. Lorsque vous appelez wait() surune promesse, le processus se bloque jusqu'à ce que la requête HTTP soit terminée et que le résultat soitrenseigné ou qu'une exception soit levée.

Lorsque vous utilisez le kit SDK avec une bibliothèque de boucles d'événements, ne bloquez pas lesrésultats. Utilisez plutôt la méthode then() d'un résultat pour accéder à une promesse résolue ou rejetéeune fois l'opération terminée.

Importations


Exemple de code

// Create an SDK class used to share configuration across clients.$sdk = new Aws\Sdk([ 'region' => 'us-west-2', 'version' => 'latest']);// Use an Aws\Sdk class to create the S3Client object.$s3Client = $sdk->createS3();

$promise = $s3Client->listBucketsAsync();$promise ->then(function ($result) { echo 'Got a result: ' . var_export($result, true); }) ->otherwise(function ($reason) { echo 'Encountered an error: ' . $reason->getMessage(); });}

Utilisation des objets de résultatL'exécution d'une opération réussie renvoie un objet Aws\Result. Plutôt que de renvoyer des donnéesbrutes XML ou JSON d'un service, le kit SDK renseigne les données de réponse dans une structure detableau associatif. Cette approche normalise certains aspects des données en fonction des connaissancesdu service spécifique et de la structure de réponse sous-jacente.

Vous pouvez accéder aux données à partir de l'objet AWSResult, comme avec un tableau PHP associatif.

11

AWS SDK pour PHP Manuel du développeurGestion des erreurs

Importations


Exemple de code

// Use the us-east-2 region and latest version of each client.$sharedConfig = [ 'profile' => 'default', 'region' => 'us-east-2', 'version' => 'latest'];


// Use an Aws\Sdk class to create the S3Client object.$s3 = $sdk->createS3();$result = $s3->listBuckets();foreach ($result['Buckets'] as $bucket) { echo $bucket['Name'] . "\n";}

// Convert the result object to a PHP array$array = $result->toArray();

Le contenu de l'objet de résultat dépend de l'opération qui a été exécutée et de la version du service. Lastructure du résultat de chaque opération d'API est détaillée dans la documentation sur l'API.

Le kit SDK comprend JMESPath, un langage spécifique au domaine utilisé pour examiner et manipuler desdonnées JSON ou, dans notre cas, des tableaux PHP. L'objet de résultat contient une méthode search()que vous pouvez utiliser pour extraire des données par déclaration du résultat.

Exemple de code

$s3 = $sdk->createS3();$result = $s3->listBuckets();

$names = $result->search('Buckets[].Name');

Gestion des erreursGestion des erreurs synchronesSi une erreur se produit lors de l'exécution d'une opération, une exception est levée. Aussi, si vous devezgérer des erreurs dans votre code, utilisez des blocs try/catch autour de vos opérations. Le kit SDK lèvedes exceptions spécifiques au service en cas d'erreur.

L'exemple suivant repose sur Aws\S3\S3Client. Si une erreur se produit, l'exception levée sera du typeAws\S3\Exception\S3Exception. Toutes les exceptions spécifiques au service levées par le kit SDKsont dérivées de la classe Aws\Exception\AwsException. Cette classe contient des informationsutiles sur l'échec, y compris l'ID de la requête, le code d'erreur et le type d'erreur. Notez que pour certainsservices qui prennent cela en charge, les données de réponse sont converties dans une structure detableau associatif (similaire à des objets Aws\Result), à laquelle il est possible d’accéder comme à untableau associatif PHP normal. La méthode toArray() renvoie tous ces données, si elles existent.

12

http://jmespath.org/

http://en.wikipedia.org/wiki/Domain-specific_language

AWS SDK pour PHP Manuel du développeurGestion des erreurs

Importations


use Aws\S3\S3Client;use Aws\Exception\AwsException;use Aws\S3\Exception\S3Exception;

Exemple de code

// Create an SDK class used to share configuration across clients.$sdk = new Aws\Sdk([ 'region' => 'us-west-2', 'version' => 'latest']);

// Use an Aws\Sdk class to create the S3Client object.$s3Client = $sdk->createS3();

try { $s3Client->createBucket(['Bucket' => 'my-bucket']);} catch (S3Exception $e) { // Catch an S3 specific exception. echo $e->getMessage();} catch (AwsException $e) { // This catches the more generic AwsException. You can grab information // from the exception using methods of the exception object. echo $e->getAwsRequestId() . "\n"; echo $e->getAwsErrorType() . "\n"; echo $e->getAwsErrorCode() . "\n";

// This dumps any modeled response data, if supported by the service // Specific members can be accessed directly (e.g. $e['MemberName']) var_dump($e->toArray());}

Gestion des erreurs asynchronesAucune exception n'est levée lors de l'envoi de requêtes asynchrones. Vous devez utiliser la méthodethen() ou otherwise() de la promesse renvoyée pour recevoir le résultat ou l'erreur.

Importations



Exemple de code

//Asynchronous Error Handling$promise = $s3Client->createBucketAsync(['Bucket' => 'my-bucket']);$promise->otherwise(function ($reason) { var_dump($reason);});

13

AWS SDK pour PHP Manuel du développeurMise à niveau depuis la version 2

// This does the same thing as the "otherwise" function.$promise->then(null, function ($reason) { var_dump($reason);});

Vous pouvez également « débloquer » la promesse et forcer la levée de l'exception.

Importations

Importations



Exemple de code

$promise = $s3Client->createBucketAsync(['Bucket' => 'my-bucket']);

//throw exceptiontry { $result = $promise->wait();} catch (S3Exception $e) { echo $e->getMessage();}

Mise à niveau depuis la version 2 du kit AWS SDKfor PHP

Cette rubrique montre comment migrer votre code pour utiliser la version 3 du kit AWS SDK for PHP et ceen quoi la nouvelle version diffère de la version 2 du kit SDK.

Note

Le modèle d'utilisation de base du kit SDK (par exemple, $result = $client->operation($params);) n'a pas changé entre la version 2 et la version 3, ce qui devrait aboutirà une migration transparente.

IntroductionLa version 3 du kit AWS SDK for PHP représente un effort important pour améliorer les capacités du kitSDK, intégrer plus de deux ans de commentaires des clients, mettre à niveau les dépendances, améliorerles performances et adopter les dernières normes PHP.

Nouveautés de la version 3La version 3 du kit AWS SDK for PHP est conforme aux normes PSR-4 et PSR-7 et se conformeradésormais à la norme SemVer.

14

http://php-fig.org

http://semver.org/

AWS SDK pour PHP Manuel du développeurChangements par rapport à la version 2

Les autres nouvelles fonctions sont les suivantes :

• Système Middleware pour personnaliser le comportement du client de service• Programmes de pagination flexibles pour l’itération sur les résultats paginés• Possibilité d’interroger les données à partir des objets de résultat et de programme de pagination avec

JMESPath• Débogage facile via l'option de configuration 'debug'

Couche HTTP découplée• Guzzle 6 est utilisé par défaut pour envoyer des demandes, mais Guzzle 5 est également pris en charge.• Le kit SDK fonctionne dans les environnements où cURL n'est pas disponible.• Les gestionnaires HTTP personnalisés sont également pris en charge.

Requêtes asynchrones• Des fonctions telles que les programmes d’attente et le chargement partitionné peuvent également être

utilisées de manière asynchrone.• Il est possible de créer des workflows asynchrones à l’aide de promesses et coroutines.• Les performances des demandes simultanées ou par lots sont améliorées.

Changements par rapport à la version 2Dépendances du projet mises à jourLes dépendances du kit SDK ont été modifiées dans cette version.

• Le kit SDK exige maintenant PHP 5.5 ou une version ultérieure. Nous utilisons abondamment lesgénérateurs dans le code de kit SDK.

• Nous avons mis à niveau le kit SDK pour utiliser Guzzle 6 (ou 5), qui assure l'implémentation sous-jacente du client HTTP utilisée par le kit SDK pour envoyer des demandes aux services AWS. Ladernière version de Guzzle amène un certain nombre d'améliorations, y compris les demandesasynchrones, les gestionnaires HTTP interchangeables, la conformité à PSR 7, de meilleuresperformances, et bien plus encore.

• Le package PSR-7 depuis le (psr/http-message) PHP-FIG définit les interfaces de représentation desrequêtes HTTP, des réponses HTTP, des URL et des flux. Ces interfaces sont utilisées dans le kit SDKet Guzzle, qui fournit l'interopérabilité avec d'autres packages conformes à PSR-7.

• L'implémentation par Guzzle de PSR-7 (guzzlehttp/psr7) fournit une implémentation des interfacesdans PSR-7, et plusieurs classes et fonctions utiles. Le kit SDK et Guzzle 6 s'appuient fortement sur cepackage.

• L'implémentation des promesses/A+ de Guzzle (guzzlehttp/promises) est utilisée dans le kit SDK etGuzzle afin de fournir des interfaces pour la gestion des demandes et coroutines asynchrones. Bien quele gestionnaire HTTP multi-cURL de Guzzle implémente le modèle d'I/O non bloquant qui permet desdemandes asynchrones, ce package fournit la possibilité de programmer dans ce modèle. Consultez lasection Promesses dans le kit AWS SDK pour PHP version 3 (p. 65) pour en savoir plus.

• L’implémentation PHP de JMESPath (mtdowling/jmespath.php) est utilisée dans le kit SDKpour fournir la fonction d’interrogation de données des méthodes Aws\Result::search() et Aws\ResultPaginator::search(). Consultez la section Expressions JMESPath dans le kit AWS SDKpour PHP version 3 (p. 85) pour en savoir plus.

15


http://php.net/manual/en/language.generators.overview.php


https://promisesaplus.com



Les options Région et Version sont maintenant obligatoiresLors de l'instanciation d'un client pour n'importe quel service, spécifiez les options 'region' et'version'. Dans la version 2 du kit AWS SDK for PHP, 'version' était entièrement facultatif et'region' était parfois facultatif. Dans la version 3, les deux sont toujours requis. Etre explicite à proposde ces deux options vous permet de verrouiller la version de l'API et la région AWS sur lesquelles vouscodez. Lorsque de nouvelles versions d'API sont créées ou de nouvelles régions AWS deviennentdisponibles, vous serez isolé des modifications avec rupture potentielle jusqu'à ce que vous soyez prêt àmettre à jour votre configuration de manière explicite.

Note

Si vous ne savez pas quelle version d'API vous utilisez, vous pouvez définir l'option 'version'sur 'latest'. Cependant, nous vous recommandons de définir les numéros de version d'API defaçon explicite pour le code de production.Tous les services ne sont pas disponibles dans toutes les régions AWS. Pour connaître la liste desrégions disponibles, consultez le document de référence Régions et points de terminaison.Pour les services qui sont disponibles uniquement via un seul point de terminaison global (par ex.,Amazon Route 53, AWS Identity and Access Management et Amazon CloudFront), instanciez lesclients en paramétrant leur région configurée sur us-east-1.

Important

Le kit SDK comprend également des clients sur plusieurs régions, qui peuvent envoyer desrequêtes à différentes régions AWS sur la base d'un paramètre (@region) fourni en tant queparamètre de commande. La région utilisée par défaut par ces clients est spécifiée avec l'optionregion fournie au constructeur client.

L'instantiation client utilise le ConstructeurDans la version 3 du kit AWS SDK for PHP, la façon dont vous instanciez un client a changé. A la placedes méthodes factory de la version 2, vous pouvez simplement instancier un client à l'aide du mot clénew.

use Aws\DynamoDb\DynamoDbClient;

// Version 2 style$client = DynamoDbClient::factory([ 'region' => 'us-east-2']);

// Version 3 style$client = new DynamoDbClient([ 'region' => 'us-east-2', 'version' => '2012-08-10']);

Note

L'instanciation d'un client à l'aide de la méthode factory() fonctionne toujours. Cependant, elleest considérée comme obsolète.

Modification de la configuration du clientLes options de configuration du client dans la version 3 du kit AWS SDK for PHP ont légèrementchangé par rapport à la version 2. Consultez la page Configuration pour le kit AWS SDK pour PHPversion 3 (p. 24) afin d’obtenir une description de toutes les options prises en charge.

16

https://docs.aws.amazon.com/general/latest/gr/rande.html


Important

Dans la version 3, les options 'key' et 'secret' ne sont plus valides au niveau de la racine,mais vous pouvez les transmettre dans le cadre de l'option 'credentials'. Une raison pourlaquelle nous avons procédé à cette modification était d'empêcher les développeurs de coder endur les informations d'identification AWS dans leurs projets.

L'objet Sdk

La version 3 du kit AWS SDK for PHP introduit l’objet Aws\Sdk en remplacement de Aws\Common\Aws.L'objet Sdk fonctionne comme une fabrique de clients. Il permet de gérer des options de configurationpartagées sur plusieurs clients.

Bien que la classe Aws dans la version 2 du kit SDK fonctionnait comme un localisateur de service (ilretournait toujours la même instance d'un client), la classe Sdk dans la version 3 renvoie une nouvelleinstance d'un client à chaque fois qu'elle est utilisée.

De plus, l'objet Sdk ne prend pas en charge le même format de fichier de configuration à partir de laversion 2 du kit SDK. Ce format de configuration a été spécifique à Guzzle 3 et est désormais obsolète. Laconfiguration peut être effectuée plus simplement avec des tableaux de base. Elle est documentée dans lasection Utilisation de la Classe Sdk (p. 8).

Certains résultats d'API ont changéPour garantir une cohérence dans la façon dont le kit SDK analyse le résultat d’une opération d’API,Amazon ElastiCache, Amazon RDS et Amazon Redshift disposent désormais d’un élément d’encapsulagesupplémentaire sur certaines réponses d’API.

Par exemple, l'appel du résultat Amazon RDSDescribeEngineDefaultParameters dans la version 3 inclutdésormais un élément d'encapsulage « EngineDefaults ». Dans la version 2, cet élément n'était pasprésent.

$client = new Aws\Rds\RdsClient([ 'region' => 'us-west-1', 'version' => '2014-09-01']);

// Version 2$result = $client->describeEngineDefaultParameters();$family = $result['DBParameterGroupFamily'];$marker = $result['Marker'];

// Version 3$result = $client->describeEngineDefaultParameters();$family = $result['EngineDefaults']['DBParameterGroupFamily'];$marker = $result['EngineDefaults']['Marker'];

Les opérations suivantes sont impactées et contiennent désormais un élément d'encapsulage dans lasortie du résultat (fournis ci-dessous entre parenthèses) :

• Amazon ElastiCache• AuthorizeCacheSecurityGroupIngress (CacheSecurityGroup)• CopySnapshot (Snapshot)• CreateCacheCluster (CacheCluster)• CreateCacheParameterGroup (CacheParameterGroup)• CreateCacheSecurityGroup (CacheSecurityGroup)• CreateCacheSubnetGroup (CacheSubnetGroup)

17

https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEngineDefaultParameters.html


• CreateReplicationGroup (ReplicationGroup)• CreateSnapshot (Snapshot)• DeleteCacheCluster (CacheCluster)• DeleteReplicationGroup (ReplicationGroup)• DeleteSnapshot (Snapshot)• DescribeEngineDefaultParameters (EngineDefaults)• ModifyCacheCluster (CacheCluster)• ModifyCacheSubnetGroup (CacheSubnetGroup)• ModifyReplicationGroup (ReplicationGroup)• PurchaseReservedCacheNodesOffering (ReservedCacheNode)• RebootCacheCluster (CacheCluster)• RevokeCacheSecurityGroupIngress (CacheSecurityGroup)

• Amazon RDS• AddSourceIdentifierToSubscription (EventSubscription)• AuthorizeDBSecurityGroupIngress (DBSecurityGroup)• CopyDBParameterGroup (DBParameterGroup)• CopyDBSnapshot (DBSnapshot)• CopyOptionGroup (OptionGroup)• CreateDBInstance (DBInstance)• CreateDBInstanceReadReplica (DBInstance)• CreateDBParameterGroup (DBParameterGroup)• CreateDBSecurityGroup (DBSecurityGroup)• CreateDBSnapshot (DBSnapshot)• CreateDBSubnetGroup (DBSubnetGroup)• CreateEventSubscription (EventSubscription)• CreateOptionGroup (OptionGroup)• DeleteDBInstance (DBInstance)• DeleteDBSnapshot (DBSnapshot)• DeleteEventSubscription (EventSubscription)• DescribeEngineDefaultParameters (EngineDefaults)• ModifyDBInstance (DBInstance)• ModifyDBSubnetGroup (DBSubnetGroup)• ModifyEventSubscription (EventSubscription)• ModifyOptionGroup (OptionGroup)• PromoteReadReplica (DBInstance)• PurchaseReservedDBInstancesOffering (ReservedDBInstance)• RebootDBInstance (DBInstance)• RemoveSourceIdentifierFromSubscription (EventSubscription)• RestoreDBInstanceFromDBSnapshot (DBInstance)• RestoreDBInstanceToPointInTime (DBInstance)• RevokeDBSecurityGroupIngress (DBSecurityGroup)

• Amazon Redshift• AuthorizeClusterSecurityGroupIngress (ClusterSecurityGroup)• AuthorizeSnapshotAccess (Snapshot)• CopyClusterSnapshot (Snapshot)

18


• CreateCluster (cluster)• CreateClusterParameterGroup (ClusterParameterGroup)• CreateClusterSecurityGroup (ClusterSecurityGroup)• CreateClusterSnapshot (Snapshot)• CreateClusterSubnetGroup (ClusterSubnetGroup)• CreateEventSubscription (EventSubscription)• CreateHsmClientCertificate (HsmClientCertificate)• CreateHsmConfiguration (HsmConfiguration)• DeleteCluster (Cluster)• DeleteClusterSnapshot (Snapshot)• DescribeDefaultClusterParameters (DefaultClusterParameters)• DisableSnapshotCopy (Cluster)• EnableSnapshotCopy (Cluster)• ModifyCluster (Cluster)• ModifyClusterSubnetGroup (ClusterSubnetGroup)• ModifyEventSubscription (EventSubscription)• ModifySnapshotCopyRetentionPeriod (Cluster)• PurchaseReservedNodeOffering (ReservedNode)• RebootCluster (Cluster)• RestoreFromClusterSnapshot (Cluster)• RevokeClusterSecurityGroupIngress (ClusterSecurityGroup)• RevokeSnapshotAccess (Snapshot)• RotateEncryptionKey (Cluster)

Suppression des classes EnumNous avons supprimé les classes Enum (par exemple, Aws\S3\Enum\CannedAcl) qui existaient dans laversion 2 du kit AWS SDK for PHP. Enums étaient des classes concrètes au sein de l'API public du kit SDKqui contenaient des constantes représentant des groupes de valeurs de paramètre valides. Etant donnéque les Enums sont spécifiques aux versions d'API, peuvent changer au fil du temps, créer des conflitsavec les mots réservés PHP, et n'étaient finalement pas très utiles, nous les avons supprimées dans laversion 3. Cela va dans le sens de la nature souple concernant l'exploitation des données et la versiond'API de la version 3.

Au lieu d'utiliser des valeurs provenant d'objets Enum, utilisez directement les valeurs littérales (parexemple, CannedAcl::PUBLIC_READ → 'public-read').

Les classes Exception affinée ont été suppriméesNous avons supprimé les classes Exception affinée qui existaient dans les espaces de noms de chaqueservice (par exemple, Aws\Rds\Exception\{SpecificError}Exception) pour des raisons similairesà celles pour lesquelles nous avons supprimé Enums. Les exceptions émises par un service ou uneopération dépendent de la version d'API qui est utilisée (elles peuvent changer d'une version à l'autre).De plus, la liste complète des exceptions qui peuvent être émises par une opération donnée n'est pasdisponible, ce qui rend les classes d'Exception affinées de la version 2 incomplètes.

Gérez les erreurs en interceptant la classe d'exception racine pour chaque service (par exemple, Aws\Rds\Exception\RdsException). Vous pouvez utiliser la méthode getAwsErrorCode() de l'exceptionpour rechercher des codes d'erreur spécifiques. Cette fonctionnalité est équivalente à celle de l'interceptionde différentes classes d'exception, mais fournit cette fonction sans ajouter la distension au kit SDK.

19


Les Classes de Façade statique ont été suppriméesDans la version 2 du kit AWS SDK for PHP, une fonction obscure inspirée par Laravel vous permettaitd’appeler enableFacades() sur la classe Aws pour activer l’accès statique aux différents clients deservice. Cette fonction est contraire aux bonnes pratiques PHP, et nous avons arrêté de la documenter ily a plus d'un an. Dans la version 3, cette fonction est complètement supprimée. Récupérez vos objets declient à partir de l'objet Aws\Sdk et utilisez-les en tant qu'instances de l'objet, et non en tant que classesstatiques.

Les programmes de pagination prévalent sur les itérateursLa version 2 du kit AWS SDK for PHP comprenait une fonction nommée *itérateurs*. Il s'agissait d'objetsqui étaient utilisés pour itérer sur des résultats paginés. On nous faisait souvent remarquer qu'ils n'étaientpas suffisamment flexibles, car l'itérateur émettait uniquement des valeurs spécifiques à partir de chaquerésultat. Si vous aviez besoin d'autres valeurs à partir des résultats, il était possible de les récupéreruniquement via des écouteurs d'événements.

Dans la version 3, les itérateurs ont été remplacés par des programmes de pagination (p. 80). Leursobjectifs sont similaires, mais les programmes de pagination sont plus flexibles. En effet, ils génèrent desobjets de résultats au lieu de valeurs d'une réponse.

Les exemples suivants illustrent la façon dont les programmes de pagination sont différents des itérateurs,en démontrant comment récupérer des résultats paginés pour l'opération S3 ListObjects à la fois dansla version 2 et la version 3.

// Version 2$objects = $s3Client->getIterator('ListObjects', ['Bucket' => 'my-bucket']);foreach ($objects as $object) { echo $object['Key'] . "\n";}

// Version 3$results = $s3Client->getPaginator('ListObjects', ['Bucket' => 'my-bucket']);foreach ($results as $result) { // You can extract any data that you want from the result. foreach ($result['Contents'] as $object) { echo $object['Key'] . "\n"; }}

Les objets de programme de pagination disposent d’une méthode search() qui vous permet d’utiliserdes expressions JMESPath (p. 85) pour extraire des données plus facilement à partir de l’ensemble derésultats.

$results = $s3Client->getPaginator('ListObjects', ['Bucket' => 'my-bucket']);foreach ($results->search('Contents[].Key') as $key) { echo $key . "\n";}

Note

La méthode getIterator() est toujours prise en charge pour permettre une transition endouceur vers la version 3, mais nous vous encourageons à migrer votre code pour permettrel'utilisation des programmes de pagination.

20

AWS SDK pour PHP Manuel du développeurComparaison d'exemples de code àpartir de deux versions du kit SDK

De nombreuses abstractions de niveau supérieur ont changéEn général, la plupart des abstractions de niveau supérieur (objets d'assistant spécifiques au service,hormis les clients) ont été améliorées ou mises à jour. Certaines ont été supprimées.

• Mis à jour:• La façon d’utiliser la fonction de chargement partitionné Amazon S3 (p. 220) a changé. Le

chargement partitionné Amazon S3 Glacier a été modifié de manière similaire.• La manière de créer les URL pré-signées Amazon S3 (p. 228) a changé.• L'espace de noms Aws\S3\Sync a été remplacé par la classe Aws\S3\Transfer. Les

méthodes S3Client::uploadDirectory() et S3Client::downloadBucket() sonttoujours disponibles, mais présentent des options différentes. Pour en savoir plus, consultez ladocumentation relative à Gestionnaire de transferts Amazon S3 avec le kit AWS SDK pour PHPversion 3 (p. 111).

• Aws\S3\Model\ClearBucket et Aws\S3\Model\DeleteObjectsBatch ont été remplacéspar Aws\S3\BatchDelete et S3Client::deleteMatchingObjects().

• Les options et comportements d’Utilisation du Gestionnaire de sessions DynamoDB avec le kitAWS SDK pour PHP version 3 (p. 100) ont légèrement changé.

• L'espace de noms Aws\DynamoDb\Model\BatchRequest a été remplacé par Aws\DynamoDb\WriteRequestBatch. Consultez la documentation pour DynamoDB WriteRequestBatch.

• Le Aws\Ses\SesClient gère désormais l'encodage base64 pour le RawMessage lors del'utilisation de l'opération SendRawEmail.

• Supprimés :• Les classes Amazon DynamoDBItem, Attribute et ItemIterator - elles étaient

précédemment obsolètes dans la version 2.7.0.• Validateur de messages Amazon SNS - il s’agit désormais d’un projet léger distinct qui ne

nécessite pas de kit SDK en tant que dépendance. Ce projet est, toutefois, inclus dans lesdistributions Phar et ZIP du kit SDK. Vous pouvez trouver un guide de démarrage sur le blog dedéveloppement PHP AWS.

• Amazon S3AcpBuilder et les objets connexes ont été supprimés.

Comparaison d'exemples de code à partir de deuxversions du kit SDKLes exemples suivants illustrent certaines façons dont l'utilisation de la version 3 du kit AWS SDK for PHPpeut différer de la version 2.

Exemple : Opération ListObjects Amazon S3Version 2 du SDK

<?php

require '/path/to/vendor/autoload.php';

use Aws\S3\S3Client;use Aws\S3\Exception\S3Exception;

$s3 = S3Client::factory([ 'profile' => 'my-credential-profile', 'region' => 'us-east-1']);

21

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.DynamoDb.WriteRequestBatch.html

https://github.com/aws/aws-sdk-php/blob/3.0.0/CHANGELOG.md#270===2014-10-08

https://github.com/aws/aws-php-sns-message-validator

http://aws.amazon.com/blogs/developer/receiving-amazon-sns-messages-in-php/

http://aws.amazon.com/blogs/developer/receiving-amazon-sns-messages-in-php/


try { $result = $s3->listObjects([ 'Bucket' => 'my-bucket-name', 'Key' => 'my-object-key' ]);

foreach ($result['Contents'] as $object) { echo $object['Key'] . "\n"; }} catch (S3Exception $e) { echo $e->getMessage() . "\n";}

Version 3 du SDK

Principales différences :

• Utilisation de new au lieu de factory() pour instancier le client.• Les options 'version' et 'region' sont requises durant l'instanciation.

<?php


use Aws\S3\S3Client;use Aws\S3\Exception\S3Exception;

$s3 = new S3Client([ 'profile' => 'my-credential-profile', 'region' => 'us-east-1', 'version' => '2006-03-01']);

try { $result = $s3->listObjects([ 'Bucket' => 'my-bucket-name', 'Key' => 'my-object-key' ]);

foreach ($result['Contents'] as $object) { echo $object['Key'] . "\n"; }} catch (S3Exception $e) { echo $e->getMessage() . "\n";}

Exemple : Instanciation d'un Client avec une configuration globaleVersion 2 du SDK

<?php return array( 'includes' => array('_aws'), 'services' => array( 'default_settings' => array( 'params' => array( 'profile' => 'my_profile', 'region' => 'us-east-1' ) ),

22


'dynamodb' => array( 'extends' => 'dynamodb', 'params' => array( 'region' => 'us-west-2' ) ), ));

<?php


use Aws\Common\Aws;

$aws = Aws::factory('path/to/my/config.php');

$sqs = $aws->get('sqs');// Note: SQS client will be configured for us-east-1.

$dynamodb = $aws->get('dynamodb');// Note: DynamoDB client will be configured for us-west-2.

Version 3 du SDK

Principales différences :

• Utilisation de la classe Aws\Sdk au lieu de la classe Aws\Common\Aws.• Il n'y a pas de fichier de configuration. À la place, utilisation d'un tableau pour la configuration.• L'option 'version' est requise durant l'instanciation.• Utilisation des méthodes create<Service>() au lieu de la méthode get('<service>').

<?php


$sdk = new Aws\Sdk([ 'profile' => 'my_profile', 'region' => 'us-east-1', 'version' => 'latest', 'DynamoDb' => [ 'region' => 'us-west-2', ],]);

$sqs = $sdk->createSqs();// Note: Amazon SQS client will be configured for us-east-1.

$dynamodb = $sdk->createDynamoDb();// Note: DynamoDB client will be configured for us-west-2.

23

AWS SDK pour PHP Manuel du développeurOptions de configuration

Configuration du kit AWS SDK forPHP version 3

Le kit AWS SDK for PHP se compose de différentes fonctions et composants. Chacune des rubriquessuivantes décrit les composants qui sont utilisés dans le kit SDK.

Rubriques• Configuration du kit AWS SDK for PHP version 3 (p. 24)• Informations d’identification pour le kit AWS SDK for PHP version 3 (p. 42)• Objets de commande dans le kit AWS SDK for PHP version 3 (p. 60)• Promesses dans le kit AWS SDK for PHP version 3 (p. 65)• Gestionnaires et intergiciel dans le kit AWS SDK for PHP version 3 (p. 70)• Flux du kit AWS SDK for PHP version 3 (p. 77)• Programmes de pagination du kit AWS SDK for PHP version 3 (p. 80)• Programmes d’attente du kit AWS SDK for PHP version 3 (p. 82)• Expressions JMESPath dans le kit AWS SDK for PHP version 3 (p. 85)• Métriques SDK dans le kit AWS SDK for PHP version 3 (p. 89)

Configuration du kit AWS SDK for PHP version 3Ce guide décrit les options de constructeur client disponibles. Ces options peuvent être fournies dans unconstructeur client ou dans la classe Aws\Sdk. Les options fournies peuvent varier selon le type de clientque vous créez. Ces options de configuration client personnalisées sont décrites dans la documentation surl’API de chaque client.

Options de configuration• api_provider (p. 25)• credentials (p. 25)• debug (p. 26)• stats (p. 28)• endpoint (p. 29)• endpoint_provider (p. 29)• endpoint_discovery (p. 30)• handler (p. 31)• http (p. 32)• http_handler (p. 37)• profile (p. 38)• région (p. 39)• retries (p. 39)• scheme (p. 39)

24



AWS SDK pour PHP Manuel du développeurapi_provider

• web (p. 40)• signature_provider (p. 40)• signature_version (p. 40)• ua_append (p. 41)• valider (p. 41)• Version (p. 42)

L'exemple suivant montre comment spécifier des options dans un constructeur client Amazon S3.


$options = [ 'region' => 'us-west-2', 'version' => '2006-03-01', 'signature_version' => 'v4'];

$s3Client = new S3Client($options);

Consultez le guide d’utilisation de base (p. 7) pour en savoir plus sur la construction des clients.

api_providerType

callable

Fonction PHP de type callable qui accepte un type, un service et un argument de version, et renvoie untableau de données de configuration correspondantes. Son type peut prendre l'une des valeurs suivantes :api, waiter ou paginator.

Par défaut, le kit SDK utilise une instance de Aws\Api\FileSystemApiProvider qui charge desfichiers API depuis le dossier src/data du kit SDK.

credentialsType

array|Aws\CacheInterface|Aws\Credentials\CredentialsInterface|bool|callable

Spécifiez un objet Aws\Credentials\CredentialsInterface pour utiliser une instance d'informationsd'identification spécifique.

$credentials = new Aws\Credentials\Credentials('key', 'secret');

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => $credentials]);

Si vous ne fournissez pas d'option credentials, le kit SDK tente de charger des informationsd'identification depuis votre environnement dans l'ordre suivant :

25

AWS SDK pour PHP Manuel du développeurdebug

1. Chargement des informations d’identification depuis les variables d’environnement (p. 44).2. Chargement des informations d’identification depuis un fichier .ini d’informations

d’identification (p. 45).3. Chargement des informations d’identification depuis un rôle IAM (p. 47).

Spécifiez false pour utiliser des informations d'identification null et si vous ne souhaitez pas signer lesrequêtes.

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => false]);

Spécifiez une fonction de type callable fournisseur d’informations d’identification (p. 50) pour créer desinformations d’identification à l’aide d’une fonction.

use Aws\Credentials\CredentialProvider;

// Only load credentials from environment variables$provider = CredentialProvider::env();

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => $provider]);

Spécifiez une instance de Aws\CacheInterface pour mettre en cache les valeurs renvoyées par lachaîne du fournisseur par défaut dans plusieurs processus.

use Aws\DoctrineCacheAdapter;use Aws\S3\S3Client;use Doctrine\Common\Cache\ApcuCache;

$s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => new DoctrineCacheAdapter(new ApcuCache),]);

La section Informations d’identification pour le kit AWS SDK pour PHP version 3 (p. 42) explique plus endétail comment fournir des informations d’identification à un client.

Note

Les informations d'identification sont chargées et validées lentement lorsqu'elles sont utilisées.

debugType

bool|array

Génère des informations de débogage sur chaque transfert. Les informations de débogage contiennent desinformations sur chaque changement d'état d'une transaction lors de sa préparation et de son envoi sur le

26

AWS SDK pour PHP Manuel du développeurdebug

réseau. La sortie de débogage comprend également des informations sur le gestionnaire HTTP spécifiqueutilisé par un client (par exemple, sortie de débogage cURL).

Définissez cette option sur true pour afficher des informations de débogage lors de l'envoi de requêtes.

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'debug' => true]);

// Perform an operation to see the debug output$s3->listBuckets();

Vous pouvez également fournir un tableau associatif contenant les clés suivantes.

logfn (callable)

Fonction appelée avec des messages de journaux. La fonction PHP echo est utilisée par défaut.stream_size (int)

Lorsque la taille d'un flux est supérieure à ce nombre, les données du flux ne sont pas consignées.Définissez cette option sur 0 si vous ne souhaitez pas consigner les données du flux.

scrub_auth (bool)

Définissez cette option sur false pour désactiver le nettoyage des données d'authentification dans lesmessages consignés (votre ID de clé d'accès et votre signature AWS seront transmises à logfn).

http (bool)

Définissez cette option sur false pour désactiver la fonction de « débogage (debug) » desgestionnaires HTTP de niveau inférieur (par exemple, sortie cURL verbose).

auth_headers (array)

Définissez un mappage clé-valeur des en-têtes que vous souhaitez remplacer avec la valeur parlaquelle vous souhaitez les remplacer. Ces valeurs ne sont pas utilisées, sauf si scrub_auth estdéfini sur true.

auth_strings (array)

Définissez un mappage clé-valeur des expressions régulières à mapper avec leurs remplacements.Ces valeurs sont utilisées par le nettoyeur de données d'authentification si scrub_auth est défini surtrue.

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'debug' => [ 'logfn' => function ($msg) { echo $msg . "\n"; }, 'stream_size' => 0, 'scrub_auth' => true, 'http' => true, 'auth_headers' => [ 'X-My-Secret-Header' => '[REDACTED]', ], 'auth_strings' => [ '/SuperSecret=[A-Za-z0-9]{20}/i' => 'SuperSecret=[REDACTED]', ], ]]);

27

AWS SDK pour PHP Manuel du développeurstats

// Perform an operation to see the debug output$s3->listBuckets();

Note

La sortie de débogage s'avère très utile pour diagnostiquer les problèmes dans le kit AWS SDKfor PHP. Veuillez fournir la sortie de débogage d'un échec isolé lorsque vous ouvrez une questionconcernant le kit SDK.

statsType

bool|array

Associe les statistiques de transfert aux erreurs et aux résultats renvoyés par les opérations du kit SDK.

Définissez cette option sur true pour collecter des statistiques de transfert sur les requêtes envoyées.

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'stats' => true]);

// Perform an operation$result = $s3->listBuckets();// Inspect the stats$stats = $result['@metadata']['transferStats'];

Vous pouvez également fournir un tableau associatif contenant les clés suivantes.

retries (bool)

Définissez cette option sur true pour activer la création de rapports sur les nouvelles tentativeseffectuées. Les statistiques sur les nouvelles tentatives sont collectées et renvoyées par défaut.

http (bool)

Définissez cette option sur true pour activer la collecte de statistiques auprès d'adaptateurs HTTP deniveau inférieur (par exemple, valeurs renvoyées dans GuzzleHttpTransferStats). Les gestionnairesHTTP doivent prendre en charge une option __on_transfer_stats pour que cette option fonctionne. Lesstatistiques HTTP sont renvoyées sous la forme d'un ensemble indexé de tableaux associatifs. Chaquetableau contient les statistiques de transfert renvoyées pour une requête par le gestionnaire HTTP duclient. Ce paramètre est désactivé par défaut.

Si une nouvelle tentative a été effectuée pour une demande, toutes les statistiques de transfertsont renvoyées. $result['@metadata']['transferStats']['http'][0] contient alors lesstatistiques de la première demande, $result['@metadata']['transferStats']['http'][1]contient celles de la deuxième demande, etc.

timer (bool)

Définissez cette option sur true pour activer un minuteur de commande qui indique le temps totalpassé sur une opération (en secondes). Ce paramètre est désactivé par défaut.

$s3 = new Aws\S3\S3Client([

28

AWS SDK pour PHP Manuel du développeurendpoint

'version' => 'latest', 'region' => 'us-west-2', 'stats' => [ 'retries' => true, 'timer' => false, 'http' => true, ]]);

// Perform an operation$result = $s3->listBuckets();// Inspect the HTTP transfer stats$stats = $result['@metadata']['transferStats']['http'];// Inspect the number of retries attempted$stats = $result['@metadata']['transferStats']['retries_attempted'];// Inspect the total backoff delay inserted between retries$stats = $result['@metadata']['transferStats']['total_retry_delay'];

endpointType

string

URI complet du service web. Cet élément est obligatoire pour les services, comme MediaConvert, quiutilisent des points de terminaison propres à un compte. Pour ces services, demandez ce point determinaison à l’aide de la méthode :doc`describeEndpoints`<emc-examples-getendpoint>`.

Cet élément est obligatoire uniquement en cas de connexion à un point de terminaison personnalisé (parexemple, une version locale de Amazon S3 ou Amazon DynamoDB Local).

Voici un exemple de connexion à Amazon DynamoDB Local :

$client = new Aws\DynamoDb\DynamoDbClient([ 'version' => '2012-08-10', 'region' => 'us-east-1' 'endpoint' => 'http://localhost:8000']);

Consultez la section Régions et points de terminaison AWS pour connaître la liste des régions et points determinaison AWS disponibles.

endpoint_providerType

callable

Fonction PHP facultative de type callable qui accepte un hachage d'options, dont des clés « service » et« region ». Cet élément renvoie NULL ou un hachage de données de point de terminaison, pour lequel laclé « endpoint » est obligatoire.

Voici un exemple de création d'un fournisseur de point de terminaison minimal.

$provider = function (array $params) { if ($params['service'] == 'foo') { return ['endpoint' => $params['region'] . '.example.com'];

29

https://aws.amazon.com/mediaconvert/

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLoca.html


AWS SDK pour PHP Manuel du développeurendpoint_discovery

} // Return null when the provider cannot handle the parameters return null;});

endpoint_discoveryType

array|Aws\CacheInterface|Aws\EndpointDiscovery\ConfigurationInterface|callable

La découverte de points de terminaison identifie et se connecte au point de terminaison correct pourune API de service qui prend en charge la découverte de points de terminaison. Pour les servicesqui prennent en charge mais ne nécessitent pas la découverte de points de terminaison, activezendpoint_discovery lors de la création du client. Si un service ne prend pas en charge la découvertede points de terminaison, cette configuration est ignorée.

Aws\EndpointDiscovery\ConfigurationInterface

Un fournisseur de configuration facultatif qui permet la connexion automatique au point de terminaisonapproprié d'une API de service pour les opérations que le service spécifie.

L'objet Aws\EndpointDiscovery\Configuration accepte deux options, dont une valeur booléenne,« enabled », qui indique si la découverte de points de terminaison est activée, et un nombre entier« cache_limit », qui indique le nombre maximal de clés dans le cache des points de terminaison.

Pour chaque client créé, transmettez un objet Aws\EndpointDiscovery\Configuration pour utiliserune configuration spécifique pour la découverte de points de terminaison.

use Aws\EndpointDiscovery\Configuration;use Aws\S3\S3Client;

$enabled = true;$cache_limit = 1000;

$config = new Aws\EndpointDiscovery\Configuration ( $enabled, $cache_limit);

$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-east-2', 'endpoint_discovery' => $config,

]);

Spécifiez une instance de Aws\CacheInterface pour mettre en cache les valeurs renvoyées par ladécouverte de points de terminaison dans plusieurs processus.

use Aws\DoctrineCacheAdapter;use Aws\S3\S3Client;use Doctrine\Common\Cache\ApcuCache;

$s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2',

30

AWS SDK pour PHP Manuel du développeurhandler

'endpoint_discovery' => new DoctrineCacheAdapter(new ApcuCache),]);

Transmettez un tableau à la découverte de points de terminaison.


$s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'endpoint_discovery' => [ 'enabled' => true, 'cache_limit' => 1000 ],]);

handlerType

callable

Gestionnaire qui accepte un objet de commande et un objet de requête, et qui renvoie une promesse(GuzzleHttp\Promise\PromiseInterface) exécutée avec un objet Aws\ResultInterface ourejetée avec Aws\Exception\AwsException. Un gestionnaire n'accepte pas un gestionnaire suivant,car il s'agit d'un élément terminal qui doit traiter une commande. Si aucun gestionnaire n'est fourni, ungestionnaire Guzzle par défaut est utilisé.

Aws\MockHandler vous permet de renvoyer des résultats fictifs ou de lancer des exceptions desimulation. Dans ce cas, vous mettez en file d'attente les résultats ou les exceptions, puis MockHandler lesretire de la file d'attente dans l'ordre FIFO.

use Aws\Result;use Aws\MockHandler;use Aws\DynamoDb\DynamoDbClient;use Aws\CommandInterface;use Psr\Http\Message\RequestInterface;use Aws\Exception\AwsException;

$mock = new MockHandler();

// Return a mocked result$mock->append(new Result(['foo' => 'bar']));

// You can provide a function to invoke; here we throw a mock exception$mock->append(function (CommandInterface $cmd, RequestInterface $req) { return new AwsException('Mock exception', $cmd);});

// Create a client with the mock handler$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'handler' => $mock]);

// Result object response will contain ['foo' => 'bar']$result = $client->listTables();

// This will throw the exception that was enqueued

31

AWS SDK pour PHP Manuel du développeurhttp

$client->listTables();

httpType

array

Défini sur un tableau d'options HTTP appliquées aux requêtes et transferts HTTP créés par le kit SDK.

Le kit SDK prend en charge les options de configuration suivantes :

certType

string|array

Spécifier le certificat au format PEM côté client.

• Définir en tant que chaîne pour le chemin d'accès au fichier de certificat uniquement.


$client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => ['cert' => '/path/to/cert.pem']]);

• Définir en tant que tableau contenant le chemin d'accès et mot de passe.


$client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'cert' => ['/path/to/cert.pem', 'password'] ]]);

connect_timeoutValeur de type float indiquant le temps d'attente en secondes lors d'une tentative de connexion à unserveur. Spécifiez la valeur 0 pour indiquer une durée indéfinie (comportement par défaut).


// Timeout after attempting to connect for 5 seconds$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [

32


'connect_timeout' => 5 ]]);

debugType

bool|resource

Indique au gestionnaire HTTP sous-jacent de générer des informations de débogage. Les informations dedébogage fournies varient selon les gestionnaires HTTP.

• Spécifiez true pour écrire la sortie de débogage dans STDOUT.• Spécifiez resource, comme renvoyé par fopen, pour écrire la sortie de débogage dans une ressource

de flux PHP spécifique.

decode_contentType

bool

Indique au gestionnaire HTTP sous-jacent de gonfler le corps des réponses compressées. Lorsque cetteoption est désactivée, les corps des réponses compressées peuvent être gonflés à l'aide de GuzzleHttp\Psr7\InflateStream.

Note

Le décodage du contenu est activé par défaut dans le gestionnaire HTTP par défaut du kit SDK.Pour des raisons de rétrocompatibilité, ce paramétrage ne peut pas être modifié. Si vous stockezdes fichiers compressés dans Amazon S3, nous vous recommandons de désactiver le décodagedu contenu au niveau du client S3.

use Aws\S3\S3Client;use GuzzleHttp\Psr7\InflateStream;

$client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => ['decode_content' => false],]);

$result = $client->getObject([ 'Bucket' => 'my-bucket', 'Key' => 'massize_gzipped_file.tgz']);

$compressedBody = $result['Body']; // This content is still gzipped$inflatedBody = new InflateStream($result['Body']); // This is now readable

delayType

int

33


Durée d'attente avant l'envoi de la requête (en millisecondes). Cette option est souvent utilisée pourretarder une nouvelle tentative de requête.

expectType

bool|string

Cette option est transmise au gestionnaire HTTP sous-jacent. Par défaut, l'en-tête Expect: 100-Continueest défini lorsque le corps de la demande dépasse 1 Mo. true ou false active ou désactive l'en-tête surtoutes les demandes. Si un nombre entier est utilisé, seules les demandes avec des corps qui dépassentce paramètre utiliseront l'en-tête. Lorsqu'elle est utilisée en tant que nombre entier, si la taille du corps estinconnue, l'en-tête Expect sera envoyé.

Warning

La désactivation de l'en-tête Expect peut empêcher le service de renvoyer l'authentification oud'autres erreurs. Cette option doit être configurée avec précautions.

progressType

callable

Définit une fonction à appeler en cas d'avancement du transfert. La fonction accepte les argumentssuivants :

1. Nombre total d'octets à télécharger estimé.2. Nombre d'octets téléchargés jusqu'à présent.3. Nombre d'octets à charger estimé.4. Nombre d'octets chargés jusqu'à présent.


$client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest']);

// Apply the http option to a specific command using the "@http"// command parameter$result = $client->getObject([ 'Bucket' => 'my-bucket', 'Key' => 'large.mov', '@http' => [ 'progress' => function ($expectedDl, $dl, $expectedUl, $ul) { printf( "%s of %s downloaded, %s of %s uploaded.\n", $expectedDl, $dl, $expectedUl, $ul ); } ]]);

34


proxyType

string|array

Vous pouvez vous connecter à un service AWS via un proxy à l'aide de l'option proxy.

• Spécifiez une valeur de type chaîne pour vous connecter à un proxy pour tous les types d'URI. La valeurde type chaîne proxy peut contenir un schéma, un nom d'utilisateur et un mot de passe. Par exemple,"http://username:[email protected]:10".

• Spécifiez un tableau associatif de paramètres proxy dans lequel la clé correspond au schéma de l'URIet la valeur correspond au proxy de l'URI donné (vous pouvez ainsi accorder différents proxys pour lespoints de terminaison « http » et « https »).


// Send requests through a single proxy$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'proxy' => 'http://192.168.16.1:10' ]]);

// Send requests through a different proxy per scheme$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'proxy' => [ 'http' => 'tcp://192.168.16.1:10', 'https' => 'tcp://192.168.16.1:11', ] ]]);

Vous pouvez utiliser la variable d'environnement HTTP_PROXY pour configurer un proxy spécifique auprotocole « http » et la variable d'environnement HTTPS_PROXY pour configurer un proxy spécifique auprotocole « https ».

sinkType

resource|string|Psr\Http\Message\StreamInterface

L'option sink permet de contrôler l'emplacement dans lequel les données de réponse d'une opération sonttéléchargées.

• Spécifiez resource, comme renvoyé par fopen, pour télécharger le corps de la réponse dans un fluxPHP.

• Spécifiez le chemin d'accès d'un fichier sur disque sous la forme d'une valeur string pour téléchargerle corps de la réponse dans ce fichier.

• Spécifiez Psr\Http\Message\StreamInterface pour télécharger le corps de la réponse dans unobjet de flux PSR spécifique.

35


Note

Le kit SDK télécharge le corps de la réponse dans un flux temporaire PHP par défaut. Ainsi, lesdonnées restent en mémoire jusqu'à ce que la taille du corps atteigne 2 Mo, puis elles sont écritesdans un fichier temporaire sur disque.

synchronousType

bool

L'option synchronous informe le gestionnaire HTTP sous-jacent que vous souhaitez bloquer le résultat.

streamType

bool

Définissez cette option sur true pour indiquer au gestionnaire HTTP sous-jacent que vous souhaitezdiffuser le corps d'une réponse depuis le service web, plutôt que de tout télécharger immédiatement. Cetteoption est utilisée par exemple dans la classe Amazon S3 « stream wrapper » afin de s'assurer que lesdonnées sont diffusées.

timeoutType

float

Valeur de type float indiquant le délai d'expiration de la requête (en secondes). Spécifiez la valeur 0 pourindiquer une durée indéfinie (comportement par défaut).


// Timeout after 5 seconds$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'timeout' => 5 ]]);

verifyType

bool|string

L'option verify http vous permet de personnaliser le comportement de la vérification des certificats SSL/TLS pairs du kit SDK.

• Définissez cette option sur true pour activer la vérification des certificats SSL/TLS pairs et utiliser lebundle d'autorité de certification (CA) par défaut fourni par le système d'exploitation.

36

AWS SDK pour PHP Manuel du développeurhttp_handler

• Définissez cette option sur false pour désactiver la vérification des certificats pairs. (Cette méthoden'est pas sécurisée !)

• Définissez cette option sur une chaîne pour indiquer le chemin d'accès à un bundle d'autorité decertification (CA) afin d'activer la vérification à l'aide de ce bundle personnalisé.

Si le bundle d'autorité de certification (CA) est introuvable pour votre système et si vous recevez uneerreur, indiquez le chemin d'accès à un bundle d'autorité de certification pour le kit SDK. Si vous n’avez pasbesoin d’un bundle d’autorité de certification spécifique (CA), Mozilla en propose un couramment utilisé,que vous pouvez télécharger ici (géré par le mainteneur de cURL). Une fois que vous disposez d'un bundled'autorité de certification (CA) sur un disque, vous pouvez définir le paramètre .ini PHP openssl.cafilede sorte qu'il pointe vers le chemin d'accès du fichier, ce qui vous permet d'ignorer l'option verify pour larequête. Vous trouverez plus de détails sur les certificats SSL sur le site web de cURL.


// Use a custom CA bundle$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'verify' => '/path/to/my/cert.pem' ]]);

// Disable SSL/TLS verification$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'verify' => false ]]);

http_handlerType

callable

L'option http_handler permet d'intégrer le kit SDK à d'autres clients HTTP. Une option http_handlerest une fonction qui accepte un objet Psr\Http\Message\RequestInterface et un ensembled'options http appliquées à la commande. Elle renvoie un objet GuzzleHttp\Promise\PromiseInterface qui est exécuté avec un objet Psr\Http\Message\ResponseInterface ourejeté avec un ensemble des données d'exception suivantes :

• exception - (\Exception) : exception rencontrée.• response - (Psr\Http\Message\ResponseInterface) : réponse reçue (le cas échéant).• connection_error - (bool) défini sur true pour marquer l'erreur comme une erreur de connexion. Si

vous définissez cette valeur sur true, le kit SDK retente automatiquement l'opération, si nécessaire.

Le kit SDK convertit automatiquement l'option http_handler donnée en option handler normale enencapsulant l'option http_handler fournie avec un objet Aws\WrappedHttpHandler.

Par défaut, le kit SDK utilise Guzzle comme gestionnaire HTTP. Vous pouvez fournir un gestionnaire HTTPdifférent ici, ou fournir à un client Guzzle vos propres options personnalisées.

37

https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt

http://curl.haxx.se/docs/sslcerts.html

AWS SDK pour PHP Manuel du développeurprofile

Définition de la version de TLS

Un cas d'utilisation consiste à définir la version de TLS utilisée par Guzzle avec Curl, en supposant queCurl est installé dans votre environnement. Notez les contraintes de version Curl concernant les versionsde TLS prise en charge. Par défaut, c'est la dernière version qui est utilisée. Si la version de TLS estexplicitement définie et que le serveur distant ne prend pas en charge cette version, il génère une erreur aulieu d'utiliser une version de TLS antérieure.

Vous pouvez déterminer la version de TLS utilisée pour une opération client donnée en définissant l'optionclient debug sur true et en examinant la sortie de connexion SSL. Cette ligne peut ressembler à ce quisuit : SSL connection using TLSv1.2

Exemple de définition de TLS 1.2 avec Guzzle 6 :

use Aws\DynamoDb\DynamoDbClient;use Aws\Handler\GuzzleV6\GuzzleHandler;use GuzzleHttp\Client;

$handler = new GuzzleHandler( new Client([ 'curl' => [ CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2 ] ]));

$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http_handler' => $handler]);

Note

L'option http_handler prévaut sur toutes les autres options handler fournies.

profileType

string

Permet de spécifier le profil à utiliser lors de la création d'informations d'identification à partir du fichierd'informations d'identification AWS de votre répertoire HOME. Ce paramètre remplace la variabled'environnement AWS_PROFILE.

Note

Si vous spécifiez « profile », la clé « credentials » sera ignorée.

// Use the "production" profile from your credentials file$ec2 = new Aws\Ec2\Ec2Client([ 'version' => '2014-10-01', 'region' => 'us-west-2', 'profile' => 'production']);

Consultez la section Informations d’identification pour le kit AWS SDK pour PHP version 3 (p. 42) pouren savoir plus sur la configuration des informations d’identification et le format de fichier .ini.

38

https://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html

AWS SDK pour PHP Manuel du développeurrégion

régionType

string

Obligatoire

vrai

Région AWS à laquelle vous souhaitez vous connecter. Consultez la section Régions et points determinaison AWS pour obtenir la liste des régions disponibles.

// Set the Region to the EU (Frankfurt) Region$s3 = new Aws\S3\S3Client([ 'region' => 'eu-central-1', 'version' => '2006-03-01']);

retriesType

int

Par défaut

int(3)

Permet de configurer le nombre maximal de nouvelles tentatives autorisées pour un client. Spécifiez 0 pourdésactiver les nouvelles tentatives.

Dans l'exemple suivant, les nouvelles tentatives sont désactivées pour le client Amazon DynamoDB.

// Disable retries by setting "retries" to 0$client = new Aws\DynamoDb\DynamoDbClient([ 'version' => '2012-08-10', 'region' => 'us-west-2', 'retries' => 0]);

schemeType

string

Par défaut

string(5) "https"

Schéma d'URI à utiliser lors de la connexion. Le kit SDK utilise des points de terminaison« https » (connexions SSL/TLS) par défaut. Vous pouvez essayer de vous connecter à un service via unpoint de terminaison « http » non chiffré en définissant scheme sur « http ».

$s3 = new Aws\S3\S3Client([

39



AWS SDK pour PHP Manuel du développeurweb

'version' => '2006-03-01', 'region' => 'us-west-2', 'scheme' => 'http']);

Consultez la section Régions et points de terminaison AWS pour connaître la liste des points determinaison et savoir si un service prend en charge le schéma http.

webType

string

Obligatoire

vrai

Nom du service à utiliser. Cette valeur est renseignée par défaut lorsque vous utilisez un client fourni par lekit SDK (Aws\S3\S3Client). Cette option s'avère utile lorsque vous testez un service qui n'a pas encoreété publié dans le kit SDK, mais dont vous disposez sur un disque.

signature_providerType

callable

Fonction de type callable qui accepte un nom de version de signature (par exemple, v4), un nom deservice et une région AWS, et qui renvoie un objet Aws\Signature\SignatureInterface ou NULLsi le fournisseur peut créer un utilisateur pour les paramètres donnés. Ce fournisseur permet de créer desutilisateurs utilisés par le client.

Le kit SDK propose plusieurs fonctions dans la classe Aws\Signature\SignatureProvider quipermettent de créer des fournisseurs de signatures personnalisés.

signature_versionType

string

Chaîne représentant une version de signature personnalisée à utiliser avec un service (par exemple, v4,etc.). Une version de signature par opération PEUT remplacer cette version de signature demandée, sinécessaire.

Les exemples suivants montrent comment configurer un client Amazon S3 pour utiliser une SignatureVersion 4 :

// Set a preferred signature version$s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-west-2', 'signature_version' => 'v4'

40


https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html


AWS SDK pour PHP Manuel du développeurua_append

]);

Note

L'option signature_provider utilisée par votre client DOIT pouvoir créer l'optionsignature_version que vous spécifiez. L'option signature_provider utilisée par défautpar le kit SDK peut créer des objets de signature pour les versions de signature « anonymous » et« v4 ».

ua_appendType

string|string[]

Par défaut

[]

Chaîne ou tableau de chaînes ajoutées à la chaîne de l'agent utilisateur transmise au gestionnaire HTTP.

validerType

bool|array

Par défaut

bool(true)

Définissez cette option sur false pour désactiver la validation des paramètres côté client. Vouspouvez constater une légère amélioration au niveau des performances du client lorsque la validation estdésactivée, mais la différence est négligeable.

// Disable client-side validation$s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'eu-west-1', 'validate' => false]);

Définissez cette option sur un tableau associatif d'options de validation pour activer des contraintes devalidation spécifiques :

• required - Vérifie que les paramètres obligatoires sont présents (activé par défaut).• min - Vérifie la longueur minimale d'une valeur (activé par défaut).• max - Vérifie la longueur maximale d'une valeur.• pattern - Vérifie que la valeur correspond à une expression régulière.

// Validate only that required values are present$s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'eu-west-1', 'validate' => ['required' => true]

41

AWS SDK pour PHP Manuel du développeurVersion

]);

VersionType

string

Obligatoire

vrai

Version du service web à utiliser (par exemple, 2006-03-01).

Une valeur de configuration « version » est obligatoire. La spécification d'une contrainte de versionvous permet de vous assurer que les modifications avec rupture apportées au service n'affecteront pasvotre code. Par exemple, si vous utilisez Amazon S3, vous pouvez verrouiller votre version de l’API sur2006-03-01.

$s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-east-1']);

Vous pouvez consulter la liste des versions d'API disponibles sur la page de documentation de l'API dechaque client. Si vous ne parvenez pas à charger une version d'API spécifique, il se peut que vous deviezmettre à jour votre copie du kit SDK.

Vous pouvez spécifier la chaîne latest dans la valeur de configuration « version » pour utiliser la versiond'API disponible la plus récente du fournisseur d'API de votre client (le fournisseur d'API par défautrecherche les modèles d'API disponibles dans le répertoire src/data du kit SDK).

// Use the latest version available$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-east-1']);

Warning

Nous vous déconseillons de spécifier latest dans une application en production. En effet,l'intégration d'une nouvelle version mineure du kit SDK comprenant une mise à jour d'API peutentraîner l'échec de votre application en production.

Informations d’identification pour le kit AWS SDK forPHP version 3

Pour envoyer des demandes à Amazon Web Services, fournissez des clés d'accès AWS, égalementappelées informations d'identification, au kit AWS SDK for PHP.

Vous pouvez effectuer cette opération de différentes manières :

• Utilisez la chaîne de fournisseur d'informations d'identification par défaut (recommandé).

42


https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html

AWS SDK pour PHP Manuel du développeurUtilisation de la chaîne de fournisseur

d'informations d'identification par défaut

• Utilisez un fournisseur ou une chaîne de fournisseur d'informations d'identification spécifique (ou créez levôtre).

• Fournissez les informations d'identification vous-même. Il peut s'agir des informations d'identificationdu compte racine, d'informations d'identification IAM ou d'informations d'identification temporairesrécupérées à partir d'AWS STS.

Important

Pour des raisons de sécurité, nous vous recommandons vivement d'utiliser des utilisateurs IAM aulieu du compte racine pour accéder à AWS. Pour de plus amples informations, veuillez consulterBonnes pratiques IAM dans le IAM User Guide.

Utilisation de la chaîne de fournisseur d'informationsd'identification par défautLorsque vous initialisez un nouveau client de service sans fournir d'argument d'informations d'identification,le kit SDK utilise la chaîne de fournisseur d'informations d'identification par défaut pour trouver lesinformations d'identification AWS. Le kit SDK utilise le premier fournisseur de la chaîne qui renvoie desinformations d'identification sans erreur.

La chaîne de fournisseur par défaut recherche et utilise les informations d'identification comme suit, danscet ordre :

1. Utilisation des informations d’identification des variables d’environnement (p. 44).

La définition de variables d'environnement est utile si vous effectuez des tâches de développement surun ordinateur autre qu'une instance Amazon EC2.

2. Utilisation des fichiers et profils des informations d’identification AWS partagés (p. 45).

Ce fichier d'informations d'identification est le même que celui utilisé par les autres kits SDK et l’AWSCLI. Si vous utilisez déjà un fichier d'informations d'identification partagé, vous pouvez utiliser ce fichier àcette fin.

Nous utilisons cette méthode dans la plupart de nos exemples de code PHP.3. Assumer un rôle IAM (p. 47).

Les rôles IAM fournissent aux applications sur l'instance des informations d'identification de sécuritétemporaires pour effectuer des appels AWS. Par exemple, les rôles IAMconstituent un moyen facile dedistribuer et gérer des informations d’identification sur plusieurs instances Amazon EC2.

Autres façons d'ajouter des informationsd'identificationVous pouvez également ajouter des informations d'identification comme suit :

• Utilisez un fournisseur d’informations d’identification (p. 50).

Fournissez une logique personnalisée pour les informations d'identification lors de la création du client.• Utilisez des informations d’identification temporaires d’AWS STS (p. 57).

Lorsque vous utilisez un jeton d’authentification multi-facteurs (MFA) pour l’authentification à deuxfacteurs, utilisez AWS STS pour accorder à l’utilisateur des informations d’identification temporaires pouraccéder aux services AWS ou utiliser le kit AWS SDK for PHP.

43

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html

AWS SDK pour PHP Manuel du développeurUtilisation des informations d’identification

des variables d’environnement

• Utilisation d’informations d’identification codées de manière irréversible (p. 59) (non recommandé).

Warning

Coder les informations d'identification de manière irréversible peut être dangereux, car il est facilede valider accidentellement les informations d'identification dans un référentiel SCM. Ceci peutéventuellement exposer les informations d'identification à un plus grand nombre de personnesque prévu. Ceci peut également rendre difficile la future rotation d'informations d'identification.N'envoyez pas du code avec des informations d'identification codées de manière irréversible àvotre contrôle de source.

• Création de clients anonymes (p. 59).

Créez un client qui n'est pas associé à des informations d'identification lorsque le service autorise unaccès anonyme.

Pour en savoir plus, consultez les bonnes pratiques d’informations d’identification de sécurité AWS dans lemanuel Référence générale d’Amazon Web Services.

Utilisation des informations d’identification desvariables d’environnementL'utilisation de variables d'environnement pour contenir vos informations d'identification vous empêchede partager accidentellement votre clé d'accès secrète AWS. Nous vous recommandons de ne jamaisajouter vos clés d'accès AWS directement dans le client dans des fichiers de production. De nombreuxdéveloppeurs ont eu leur compte compromis en raison de fuites de clés.

Pour l'authentification dans Amazon Web Services, le kit SDK recherche d'abord les informationsd'identification dans vos variables d'environnement. Le kit SDK utilise la fonction getenv() pourrechercher les variables d'environnement AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY etAWS_SESSION_TOKEN. Ces informations d’identification sont appelées informations d’identificationd’environnement.

Si vous hébergez votre application sur AWS Elastic Beanstalk, vous pouvez définir les variablesd'environnement AWS_ACCESS_KEY_ID et AWS_SECRET_KEY via la console AWS Elastic Beanstalk pourque le kit SDK puisse utiliser ces informations d'identification automatiquement.

Vous pouvez également définir les variables d'environnement dans la ligne de commande, comme illustréici.

Linux

$ export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE # The access key for your AWS account.$ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY # The secret access key for your AWS account.$ export AWS_SESSION_TOKEN=AQoDYXdzEJr...<remainder of security token> # The session key for your AWS account. This is needed only when you are using temporary credentials. # The AWS_SECURITY_TOKEN environment variable can also be used, but is only supported for backward compatibility purposes. # AWS_SESSION_TOKEN is supported by multiple AWS SDKs other than PHP.

Windows

C:\> SET AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE

44

https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html

https://docs.aws.amazon.com/general/latest/gr/

https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/create_deploy_PHP_eb.html

AWS SDK pour PHP Manuel du développeurUtilisation du fichier d’informations d’identificationAWS et des profils d’informations d’identification

# The access key for your AWS account.C:\> SET AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY # The secret access key for your AWS account.C:\> SET AWS_SESSION_TOKEN=AQoDYXdzEJr...<remainder of security token> # The session key for your AWS account. This is needed only when you are using temporary credentials. # The AWS_SECURITY_TOKEN environment variable can also be used, but is only supported for backward compatibility purposes. # AWS_SESSION_TOKEN is supported by multiple AWS SDKs besides PHP.

Utilisation du fichier d’informations d’identification AWSet des profils d’informations d’identificationUn fichier d'informations d'identification est un fichier texte brut qui contient vos clés d'accès. Le fichier doit :

• Être sur la même machine que celle où vous exécutez votre application.• Être nommé credentials.• Être situé dans le dossier .aws/ de votre répertoire de base.

Le répertoire de base peuvent varier selon le système d'exploitation. Sous Windows, vous pouvez faireréférence à votre répertoire de base à l'aide de la variable d'environnement %UserProfile%. Sur lessystèmes Unix, vous pouvez utiliser la variable d'environnement $HOME ou ~ (tilde).

Si vous utilisez déjà ce fichier pour d'autres kits SDK et outils (tels que l'AWS CLI), vous n'avez pas besoinde modifier quoi que ce soit pour utiliser les fichiers dans ce kit SDK. Si vous utilisez des informationsd’identification différentes selon les outils ou les applications, vous pouvez utiliser des profils pourconfigurer plusieurs clés d’accès dans le même fichier de configuration.

Nous utilisons cette méthode dans tous nos exemples de code PHP.

L'utilisation d'un fichier d'informations d'identification AWS offre les avantages suivants :

• Les informations d'identification des projets sont stockées à l'extérieur des projets, ce qui permet d'éviterde les valider accidentellement dans le contrôle de version.

• Vous pouvez définir et nommer plusieurs jeux d'informations d'identification en un seul endroit.• Vous pouvez facilement réutiliser les mêmes informations d'identification entre les projets.• D’autres kits de développement logiciel (SDK) AWS et outils prennent en charge ce fichier d'informations

d'identification. Ceci vous permet de réutiliser les informations d'identification avec d'autres outils.

Le format du fichier d'informations d'identification AWS devrait ressembler à ce qui suit.

[default]aws_access_key_id = YOUR_AWS_ACCESS_KEY_IDaws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY

[project1]aws_access_key_id = ANOTHER_AWS_ACCESS_KEY_IDaws_secret_access_key = ANOTHER_AWS_SECRET_ACCESS_KEY

Chaque section (par ex. [default], [project1]), représente un profil d'informations d'identificationséparé. Vous pouvez référencer des profils à partir d'un fichier de configuration de kit SDK, ou lorsque vousinstanciez un client, à l'aide de l'option profile.


45

AWS SDK pour PHP Manuel du développeurUtilisation du fichier d’informations d’identificationAWS et des profils d’informations d’identification

// Instantiate a client with the credentials from the project1 profile$client = new DynamoDbClient([ 'profile' => 'project1', 'region' => 'us-west-2', 'version' => 'latest']);

Si aucune information d'identification ni aucun profil n'a été explicitement fourni au kit SDK et qu'aucuneinformation d'identification n'a été définie dans les variables d'environnement, mais qu'un fichierd'informations d'identification est défini, le kit SDK utilise le profil « par défaut ». Vous pouvez modifier leprofil par défaut en spécifiant un autre nom de profil dans la AWS_PROFILE variable d'environnement.

Assumer un rôle avec un profilVous pouvez configurer le kit SDK AWS pour PHP afin qu'il utilise un rôle IAM en définissant un profil pource rôle dans ~/.aws/credentials.

Créez un nouveau profil avec le role_arn du rôle que vous allez assumer. Incluez également lesource_profile d'un profil avec des informations d'identification ayant les autorisations permettantd'assumer le rôle IAM.

Profil dans ~/.aws/credentials :

[default]aws_access_key_id = YOUR_AWS_ACCESS_KEY_IDaws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY

[project1]role_arn = arn:aws:iam::123456789012:role/testingsource_profile = defaultrole_session_name = OPTIONAL_SESSION_NAME

Si vous définissez la variable d'environnement AWS_PROFILE ou l'option profile lors de l'instanciationd'un client, le rôle spécifié dans project1 sera assumé, en utilisant le profil default comme informationsd'identification source.

Les rôles peuvent également être assumés pour des profils définis dans ~/.aws/config. La définitionde la variable d'environnement AWS_SDK_LOAD_NONDEFAULT_CONFIG permet de charger des profilspour assumer un rôle à partir de ~/.aws/config. Lorsque cette option est activée, les profils définisdans ~/.aws/config et ~/.aws/credentials sont chargés. Les profils définis dans ~/.aws/credentials sont chargés les derniers et sont prioritaires par rapport à un profil défini dans ~/.aws/config du même nom. Les profils définis dans ces emplacements peuvent être utilisés en tant quesource_profile ou que profil à assumer.

Profil dans ~/.aws/config:

[profile project1]role_arn = arn:aws:iam::123456789012:role/testingsource_profile = defaultrole_session_name = OPTIONAL_SESSION_NAME

Profil dans ~/.aws/credentials:

[project2]aws_access_key_id = YOUR_AWS_ACCESS_KEY_IDaws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY

46

AWS SDK pour PHP Manuel du développeurAssumer un rôle IAM

Avec les fichiers ci-dessus, [project1] sera assumé à l'aide de [project2] en tant qu’informationsd'identification.

Assumer des rôles IAMUtilisation de rôles IAM pour les informations d’identification devariable d’instance Amazon EC2Si vous exécutez votre application sur une instance Amazon EC2, le meilleur moyen de fournir desinformations d'identification pour effectuer des appels vers AWS consiste à utiliser un rôle IAM pour obtenirdes informations d'identification de sécurité temporaires.

Lorsque vous utilisez des rôles IAM, vous n'avez pas à vous préoccuper de la gestion des informationsd'identification provenant de l'application. Ces rôles permettent à une instance « d'assumer » un rôleen récupérant temporairement les informations d'identification auprès du serveur de métadonnées del'instance Amazon EC2.

Les informations d'identification temporaires, souvent appelées informations d'identification de profild'instance, permettent d'accéder aux actions et aux ressources que la stratégie du rôle autorise. AmazonEC2 gère toutes les opérations d'authentification des instances en toute sécurité sur le service IAM pourassumer le rôle et d'actualisation régulière des informations d'identification du rôle récupérées. Ceci permetde sécuriser l'application presque sans effort de votre part.

Note

Les informations d’identification du profil d’instance et d’autres informations d’identificationtemporaires générées par AWS Security Token Service (AWS STS) ne sont pas prises en chargepar tous les services. Pour savoir si le service que vous utilisez prend en charge les informationsd'identification temporaires, veuillez consulter Services AWS qui fonctionnent avec AWS STS.Pour éviter d'accéder au service de métadonnées chaque fois, vous pouvez transmettre uneinstance Aws\CacheInterface en tant qu'option 'credentials' à un constructeur client. Cecipermet au kit SDK d'utiliser des informations d'identification du profil d'instance mises en cache àla place. Pour plus d’informations, consultez la section Configuration du kit AWS SDK pour PHPversion 3 (p. 24).

Création et attribution d’un rôle IAM à une instance Amazon EC2

1. Créez un client IAM.

Importations


use Aws\Iam\IamClient;

Exemple de code

$client = new IamClient([ 'region' => 'us-west-2', 'version' => '2010-05-08']);

2. Créez un rôle IAM avec les autorisations pour les actions et ressources que vous utiliserez.

Exemple de code

$result = $client->createRole([

47

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html


'AssumeRolePolicyDocument' => 'IAM JSON Policy', // REQUIRED 'Description' => 'Description of Role', 'RoleName' => 'RoleName', // REQUIRED]);

3. Créez un profil d'instance IAM et stockez l'Amazon Resource Name (ARN) du résultat.Note

Si vous utilisez la console IAM au lieu du kit AWS SDK for PHP, la console créeautomatiquement un profil d’instance et lui attribue le même nom qu’au rôle auquel ilcorrespond.Exemple de code

$IPN = 'InstanceProfileName';

$result = $client->createInstanceProfile([ 'InstanceProfileName' => $IPN ,]);

$ARN = $result['Arn'];$InstanceID = $result['InstanceProfileId'];

4. Créez un client Amazon EC2.

Importations


use Aws\Ec2\Ec2Client;

Exemple de code

$ec2Client = new Ec2Client([ 'region' => 'us-west-2', 'version' => '2016-11-15',]);

5. Ajoutez le profil d'instance à une instance Amazon EC2 en cours d'exécution ou arrêtée. Utilisez le nomde profil d'instance de votre rôle IAM.

Exemple de code

$result = $ec2Client->associateIamInstanceProfile([ 'IamInstanceProfile' => [ 'Arn' => $ARN, 'Name' => $IPN, ], 'InstanceId' => $InstanceID]);

Pour plus d’informations, consultez la section Rôles IAM pour Amazon EC2.

Utilisation de rôles IAM pour les tâches Amazon ECSEn utilisant des rôles IAM pour les tâches Amazon Elastic Container Service (Amazon ECS), vous pouvezspécifier un rôle IAM qui peut être utilisé par les conteneurs. Ceci constitue une stratégie de gestion desinformations d’identification à utiliser pour les applications, de la même façon que les profils d’instanceAmazon EC2 fournissent des informations d’identification aux instances Amazon EC2.

48

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html


Au lieu de créer et distribuer vos informations d’identification AWS aux conteneurs ou d’utiliser le rôle del’instance Amazon EC2, vous pouvez associer un rôle IAM à une définition de tâche ECS ou une opérationd’API RunTask.

Note

Les informations d'identification du profil d'instance et les autres informations d'identificationtemporaires générées par AWS STS ne sont pas prises en charge par tous les services. Poursavoir si le service que vous utilisez prend en charge les informations d'identification temporaires,veuillez consulter Services AWS qui fonctionnent avec AWS STS.

Pour plus d’informations, consultez la section Rôles IAM pour les tâches Amazon EC2 Container Service.

Comment assumer un rôle IAM dans un autre compte AWSLorsque vous travaillez dans un compte AWS (compte A) et que vous souhaitez assumer un rôle dansun autre compte (compte B), vous devez d'abord créer un rôle IAM dans le compte B. Ce rôle permet auxentités dans votre compte (compte A) d'effectuer des actions spécifiques dans le compte B. Pour de plusamples informations sur l'accès entre comptes, veuillez consulter Didacticiel : Déléguer l'accès entre descomptes AWS à l'aide de rôles IAM.

Une fois que vous avez créé un rôle dans le compte B, enregistrez l'ARN de rôle. Vous utiliserez cetARN lorsque vous assumerez le rôle du compte A. Vous assumez le rôle en utilisant les informationsd'identification AWS associées à votre entité dans le compte A.

Créez un client AWS STS avec les informations d'identification de votre compte AWS. Dans ce qui suit,nous avons utilisé un profil d'informations d'identification, mais vous pouvez utiliser n'importe quelleméthode. Avec le client AWS STS que vous venez de créer, appelez la commande assume-role etfournissez un élément sessionName personnalisé. Récupérez les nouvelles informations d'identificationtemporaires à partir du résultat. Par défaut, les informations d'identification sont valables une heure.

Exemple de code

$stsClient = new Aws\Sts\StsClient([ 'profile' => 'default', 'region' => 'us-east-2', 'version' => '2011-06-15']);

$ARN = "arn:aws:iam::123456789012:role/xaccounts3access";$sessionName = "s3-access-example";

$result = $stsClient->AssumeRole([ 'RoleArn' => $ARN, 'RoleSessionName' => $sessionName,]);

$s3Client = new S3Client([ 'version' => '2006-03-01', 'region' => 'us-west-2', 'credentials' => [ 'key' => $result['Credentials']['AccessKeyId'], 'secret' => $result['Credentials']['SecretAccessKey'], 'token' => $result['Credentials']['SessionToken'] ]]);

Pour de plus amples informations, veuillez consulter Utilisation de rôles IAM ou AssumeRole dans laréférence de l’API AWS SDK for PHP.

49

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ecs-2014-11-13.html#runtask

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/task-iam-roles.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#assumerole

AWS SDK pour PHP Manuel du développeurUtilisation d’un fournisseur d’informations d’identification

Utilisation d'un rôle IAM avec la fédération d’identité webLa fédération d'identité web permet aux clients d'utiliser des fournisseurs d'identité tiers pourl'authentification lors de l'accès aux ressources AWS. Pour pouvoir assumer un rôle avec la fédérationd'identité web, vous devez créer un rôle IAM et configurer un fournisseur d'identité web (IdP). Pour deplus amples informations, veuillez consulter Création d'un rôle pour la fédération d'identité web ou OpenIDConnect Federation (Console).

Après avoir créé un fournisseur d'identité et créé un rôle pour votre identité web, utilisez un client AWS STSpour authentifier un utilisateur. Fournissez le jeton webIdentityToken et l'ID ProviderId pour votre identité,ainsi que l'ARN de rôle pour le rôle IAM avec des autorisations pour l'utilisateur.

Exemple de code

$stsClient = new Aws\Sts\StsClient([ 'profile' => 'default', 'region' => 'us-east-2', 'version' => '2011-06-15']);

$ARN = "arn:aws:iam::123456789012:role/xaccounts3access";$sessionName = "s3-access-example";$duration = 3600;

$result = $stsClient->AssumeRoleWithWebIdentity([ 'WebIdentityToken' => "FACEBOOK_ACCESS_TOKEN", 'ProviderId' => "graph.facebook.com", 'RoleArn' => $ARN, 'RoleSessionName' => $sessionName,]);


Pour de plus amples informations, veuillez consulter AssumeRoleWithWebIdentity - Fédération via unfournisseur d'identité web ou AssumeRoleWithWebIdentity dans la référence de l'API AWS SDK for PHP.

Utilisation d’un fournisseur d’informationsd’identificationUn fournisseur d'informations d'identification est une fonction qui renvoie un GuzzleHttp\Promise\PromiseInterface qui est exécutée avec une instance Aws\Credentials\CredentialsInterface ou rejetée avec une Aws\Exception\CredentialsException. Vouspouvez utiliser des fournisseurs d'informations d'identification pour mettre en œuvre votre propre logiquepersonnalisée pour créer des informations d'identification ou pour optimiser le chargement des informationsd'identification.

Les fournisseurs d'informations d'identification sont transmis à l'option constructeur client credentials.Les fournisseurs d'informations d'identification sont asynchrones, ce qui les oblige à être lentement évaluéschaque fois qu'une opération d'API est appelée. À ce titre, la transmission d'une fonction de fournisseurd'informations d'identification à un constructeur client SDK ne valide pas immédiatement les informations

50

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html


https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html


https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#assumerolewithwebidentity


d'identification. Si le fournisseur d'informations d'identification ne renvoie pas l'objet des informationsd'identification, une opération d'API sera rejetée avec une Aws\Exception\CredentialsException.

use Aws\Credentials\CredentialProvider;use Aws\S3\S3Client;

// Use the default credential provider$provider = CredentialProvider::defaultProvider();

// Pass the provider to the client$client = new S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01', 'credentials' => $provider]);

Fournisseurs intégrés dans le kit SDKLe kit SDK fournit plusieurs fournisseurs intégrés que vous pouvez combiner avec des fournisseurspersonnalisés.

Important

Les fournisseurs d'informations d'identification sont appelés chaque fois qu'une opération d'APIest effectuée. Si le chargement d'informations d'identification est une tâche coûteuse (parexemple, le chargement à partir d'un disque ou d'une ressource réseau) ou si les informationsd'identification ne sont pas mises en cache par le fournisseur, envisagez d'encapsulervotre fournisseur d'informations d'identification dans une fonction Aws\Credentials\CredentialProvider::memoize. Le fournisseur d'informations d'identification par défaututilisé par le kit SDK est automatiquement mémoïsé.

fournisseur assumeRoleSi vous utilisez Aws\Credentials\AssumeRoleCredentialProvider pour créer des informationsd'identification en assumant un rôle, vous devez fournir les informations 'client' avec un objetStsClient et des détails 'assume_role_params' comme illustré.

Note

Pour éviter l’extraction inutile d’informations d’identification AWS STS à chaque opérationd’API, vous pouvez utiliser la fonction memoize afin de prendre en charge automatiquement lerafraîchissement des informations d’identification lorsqu’elles expirent. Consultez le code suivantpour obtenir un exemple.

use Aws\Credentials\CredentialProvider;use Aws\S3\S3Client;use Aws\Sts\StsClient;

// Passing Aws\Credentials\AssumeRoleCredentialProvider options directly$profile = new InstanceProfileProvider();$ARN = "arn:aws:iam::123456789012:role/xaccounts3access";$sessionName = "s3-access-example";

$assumeRoleCredentials = new AssumeRoleCredentialProvider([ 'client' => new StsClient([ 'region' => 'us-east-2', 'version' => '2011-06-15' 'credentials' => $profile ]), 'assume_role_params' => [ 'RoleArn' => $ARN,

51


'RoleSessionName' => $sessionName, ],]);

// To avoid unnecessarily fetching STS credentials on every API operation,// the memoize function handles automatically refreshing the credentials when they expire$provider = CredentialProvider::memoize($assumeRoleCredentials);

$client = new S3Client([ 'region' => 'us-east-2', 'version' => '2006-03-01', 'credentials' => $provider]);

Pour plus d’informations sur 'assume_role_params', veuillez consulter AssumeRole.

Chaînage des fournisseursVous pouvez chaîner des fournisseurs d'informations d'identification à l'aide de la fonction Aws\Credentials\CredentialProvider::chain(). Cette fonction accepte un nombre d'argumentsvariadique, chacun d'entre eux étant une fonction de fournisseur d'informations d'identification. Cettefonction renvoie ensuite une nouvelle fonction qui est la composition des fonctions fournies, de façon àce qu'elles soient appelées les unes après les autres jusqu'à ce que l'un des fournisseurs renvoie unepromesse tenue.

Le defaultProvider utilise cette composition pour vérifier plusieurs fournisseurs avant un échec. Lasource du defaultProvider illustre l'utilisation de la fonction chain.

// This function returns a providerpublic static function defaultProvider(array $config = []){ // This function is the provider, which is actually the composition // of multiple providers. Notice that we are also memoizing the result by // default. return self::memoize( self::chain( self::env(), self::ini(), self::instanceProfile($config) ) );}

Création d'un fournisseur personnaliséLes fournisseurs d'informations d'identification sont simplement des fonctions qui, lorsqu'elles sontappelées, renvoient une promesse (GuzzleHttp\Promise\PromiseInterface) tenue grâceà un objet Aws\Credentials\CredentialsInterface ou rejetée via une Aws\Exception\CredentialsException.

Une bonne pratique pour créer des fournisseurs consiste à créer une fonction qui est appelée pour créerle véritable fournisseur d'informations d'identification. Par exemple, voici la source du fournisseur env(légèrement modifiée pour cet exemple). Notez qu'il s'agit d'une fonction qui renvoie la fonction du véritablefournisseur. Ceci vous permet de composer facilement des fournisseurs d'informations d'identification et deles transmettre comme valeurs.

use GuzzleHttp\Promise;use GuzzleHttp\Promise\RejectedPromise;

// This function CREATES a credential provider

52

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-sts-2011-06-15.html#assumerole


public static function env(){ // This function IS the credential provider return function () { // Use credentials from environment variables, if available $key = getenv(self::ENV_KEY); $secret = getenv(self::ENV_SECRET); if ($key && $secret) { return Promise\promise_for( new Credentials($key, $secret, getenv(self::ENV_SESSION)) ); }

$msg = 'Could not find environment variable ' . 'credentials in ' . self::ENV_KEY . '/' . self::ENV_SECRET; return new RejectedPromise(new CredentialsException($msg)); };}

fournisseur defaultProviderAws\Credentials\CredentialProvider::defaultProvider est le fournisseur d'informationsd'identification par défaut. Ce fournisseur est utilisé si vous omettez une option credentials lorsde la création d'un client. Il tente de charger les informations d'identification à partir des variablesd'environnement, puis à partir d'un fichier .ini (d'abord d'un fichier .aws/credentials, puis d'un fichier.aws/config), et enfin, à partir d'un profil d'instance (d'abord EcsCredentials, puis de métadonnéesEc2).

Note

Le résultat du fournisseur par défaut est automatiquement mémoïsé.

fournisseur ecsCredentialsAws\Credentials\CredentialProvider::ecsCredentials tente de charger les informationsd'identification via une demande GET, dont l'URI est spécifié par la variable d'environnementAWS_CONTAINER_CREDENTIALS_RELATIVE_URI dans le conteneur.


$provider = CredentialProvider::ecsCredentials();// Be sure to memoize the credentials$memoizedProvider = CredentialProvider::memoize($provider);

$client = new S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01', 'credentials' => $memoizedProvider]);

env. fournisseurAws\Credentials\CredentialProvider::env tente de charger les informations d'identification àpartir des variables d'environnement.


$client = new S3Client([ 'region' => 'us-west-2',

53


'version' => '2006-03-01', 'credentials' => CredentialProvider::env()]);

assumer un rôle à l'aide d'un fournisseur d'identité webAws\Credentials\CredentialProvider::assumeRoleWithWebIdentityCredentialProvidertente de charger les informations d'identification en endossant un rôle. Si les variables d'environnementAWS_ROLE_ARN et AWS_WEB_IDENTITY_TOKEN_FILE sont présentes, le fournisseur tentera d'endosserle rôle spécifié à AWS_ROLE_ARN à l’aide du jeton sur le disque au chemin d'accès complet spécifié dansAWS_WEB_IDENTITY_TOKEN_FILE. Si les variables d'environnement sont utilisées, le fournisseur tenterade définir la session à partir de la variable d'environnement AWS_ROLE_SESSION_NAME.

Si les variables d'environnement ne sont pas définies, le fournisseur utilise le profil par défaut, ou celuidéfini en tant que AWS_PROFILE. Le fournisseur lit les profils à partir de ~/.aws/credentials et~/.aws/config par défaut, et peut lire depuis des profils spécifiés dans l'option de configurationfilename. Le fournisseur va endosser le rôle dans role_arn du profil, la lecture d'un jeton envoyé àpartir du chemin d'accès complet défini dans web_identity_token_file. role_session_name serautilisée si elle est définie sur le profil.

Le fournisseur est appelé dans le cadre de la chaîne par défaut et peut être appelé directement.


$provider = CredentialProvider::assumeRoleWithWebIdentityCredentialProvider();// Cache the results in a memoize function to avoid loading and parsing// the ini file on every API operation$provider = CredentialProvider::memoize($provider);

$client = new S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01', 'credentials' => $provider]);

Par défaut, ce fournisseur d'informations d'identification hérite de la région configurée qui sera utiliséepar le client StsClient pour assumer le rôle. Le cas échéant, un StsClient complet peut être fourni. Lesinformations d'identification doivent être définies comme false sur n'importe quel StsClient fourni.

use Aws\Credentials\CredentialProvider;use Aws\S3\S3Client;use Aws\Sts\StsClient;

$stsClient = new StsClient([ 'region' => 'us-west-2', 'version' => 'latest', 'credentials' => false])

$provider = CredentialProvider::assumeRoleWithWebIdentityCredentialProvider([ 'stsClient' => $stsClient]);// Cache the results in a memoize function to avoid loading and parsing// the ini file on every API operation$provider = CredentialProvider::memoize($provider);

$client = new S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01', 'credentials' => $provider

54


]);

fournisseur iniAws\Credentials\CredentialProvider::ini tente de charger les informations d’identification àpartir d’un fichier d’informations d’identification ini (p. 45). Par défaut, le kit SDK tente de charger le profil« par défaut » à partir d'un fichier situé dans ~/.aws/credentials.


$provider = CredentialProvider::ini();// Cache the results in a memoize function to avoid loading and parsing// the ini file on every API operation$provider = CredentialProvider::memoize($provider);


Vous pouvez utiliser un profil personnalisé ou un emplacement de fichier .ini en fournissant des argumentsà la fonction qui crée le fournisseur.

$profile = 'production';$path = '/full/path/to/credentials.ini';

$provider = CredentialProvider::ini($profile, $path);$provider = CredentialProvider::memoize($provider);


fournisseur de processusAws\Credentials\CredentialProvider::process tente de charger des informations d'identificationà partir d'un credential_process spécifié dans un fichier d'informations d'identification ini (p. 45).Par défaut, le kit SDK tente de charger le profil « par défaut » à partir d'un fichier situé dans ~/.aws/credentials. Le kit SDK appellera la commande credential_process exactement telle que fournie, puislira les données JSON à partir de stdout. Le credential_process doit écrire les informations d'identificationvers stdout au format suivant :

{ "Version": 1, "AccessKeyId": "", "SecretAccessKey": "", "SessionToken": "", "Expiration": ""}

SessionToken et Expiration sont facultatifs. Le cas échéant, les informations d'identification seronttraitées comme temporaires.


55


$provider = CredentialProvider::process();// Cache the results in a memoize function to avoid loading and parsing// the ini file on every API operation$provider = CredentialProvider::memoize($provider);


Vous pouvez utiliser un profil personnalisé ou un emplacement de fichier .ini en fournissant des argumentsà la fonction qui crée le fournisseur.

$profile = 'production';$path = '/full/path/to/credentials.ini';

$provider = CredentialProvider::process($profile, $path);$provider = CredentialProvider::memoize($provider);


fournisseur instanceProfileAws\Credentials\CredentialProvider::instanceProfile tente de charger les informationsd’identification des profils d’instance Amazon EC2.


$provider = CredentialProvider::instanceProfile();// Be sure to memoize the credentials$memoizedProvider = CredentialProvider::memoize($provider);

$client = new S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01', 'credentials' => $memoizedProvider]);

Par défaut, le fournisseur réessaie de récupérer les informations d'identification jusqu'à trois fois. Lenombre de nouvelles tentatives peut être défini avec l'option retries et totalement désactivé endéfinissant l'option sur 0.


$provider = CredentialProvider::instanceProfile([ 'retries' => 0]);$memoizedProvider = CredentialProvider::memoize($provider);

Note

Vous pouvez désactiver cette tentative de chargement à partir de profils d’instance Amazon EC2en définissant la variable d’environnement AWS_EC2_METADATA_DISABLED comme étant true.

56

AWS SDK pour PHP Manuel du développeurUtilisation des informations

d’identification temporaires d’AWS STS

Mémoïsation d'informations d'identificationIl est parfois nécessaire de créer un fournisseur d'informations d'identification qui se souvient de ladernière valeur renvoyée. Ceci peut être utile aux performances lorsque le chargement des informationsd'identification est une opération coûteuse ou lors de l'usage de la classe Aws\Sdk pour partager unfournisseur d'informations d'identification entre plusieurs clients. Vous pouvez ajouter la mémoïsationà un fournisseur d'informations d'identification en encapsulant la fonction du fournisseur d'informationsd'identification dans une fonction memoize.


$provider = CredentialProvider::instanceProfile();// Wrap the actual provider in a memoize function$provider = CredentialProvider::memoize($provider);

// Pass the provider into the Sdk class and share the provider// across multiple clients. Each time a new client is constructed,// it will use the previously returned credentials as long as// they haven't yet expired.$sdk = new Aws\Sdk(['credentials' => $provider]);

$s3 = $sdk->getS3(['region' => 'us-west-2', 'version' => 'latest']);$ec2 = $sdk->getEc2(['region' => 'us-west-2', 'version' => 'latest']);

assert($s3->getCredentials() === $ec2->getCredentials());

Lorsque les informations d'identification mémoïsées expirent, l'habillage mémoïsé appelle le fournisseurhabillé dans une tentative de rafraîchissement des informations d'identification.

Utilisation des informations d’identification temporairesd’AWS STSAWS Security Token Service (AWS STS) vous permet de demander des informations d’identificationtemporaires à privilège limité pour les utilisateurs AWS IAM ou pour les utilisateurs que vous authentifiezvia une fédération des identités.

Un cas d’utilisation courant d’informations d’identification temporaires consiste à accorder l’accès àdes applications mobiles ou côté client à des ressources AWS en authentifiant les utilisateurs via desfournisseurs d’identité tiers (consultez la section Fédération des identités Web).

Note

Les informations d'identification temporaires générées par AWS STS ne sont pas prises encharge par tous les services. Pour savoir si le service que vous utilisez prend en charge lesinformations d’identification temporaires, consultez la section Informations d’identification desécurité temporaires IAM.

Obtention d'informations d'indentification temporairesAWS STS présente plusieurs opérations qui renvoient des informations d’identification temporaires, maisl’opération GetSessionToken est la plus simple à démontrer. En supposant que vous disposez d'uneinstance Aws\Sts\StsClient stockée dans la variable $stsClient, vous l'appelez comme suit.

$result = $stsClient->getSessionToken();

Le résultat pour GetSessionToken et les autres opérations AWS STS contient toujours une valeur'Credentials'. Si vous imprimez le résultat (par exemple, print_r($result)), il ressemble à ce quisuit.

57

https://docs.aws.amazon.com/STS/latest/APIReference/API_Welcome.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html


AWS SDK pour PHP Manuel du développeurUtilisation des informations

d’identification temporaires d’AWS STS

Array( ... [Credentials] => Array ( [SessionToken] => '<base64 encoded session token value>' [SecretAccessKey] => '<temporary secret access key value>' [Expiration] => 2013-11-01T01:57:52Z [AccessKeyId] => '<temporary access key value>' ) ...)

Fourniture des informations d'identification temporaires pour le kitAWS SDK for PHPVous pouvez utiliser des informations d'identification temporaires avec un autre client AWS en instanciantle client et en transmettant les valeurs reçues d'AWS STS directement.




Vous pouvez également construire un objet Aws\Credentials\Credentials et l'utiliser lorsque vousinstanciez le client.

use Aws\Credentials\Credentials;use Aws\S3\S3Client;


$credentials = new Credentials( $result['Credentials']['AccessKeyId'], $result['Credentials']['SecretAccessKey'], $result['Credentials']['SessionToken']);

$s3Client = new S3Client([ 'version' => '2006-03-01', 'region' => 'us-west-2', 'credentials' => $credentials]);

Toutefois, le meilleur moyen de fournir des informations d’identification temporaires consiste à utiliser laméthode d’assistance createCredentials() incluse avec le StsClient. Cette méthode extrait lesdonnées à partir d’un résultat AWS STS et crée l’objet Credentials pour vous.

$result = $stsClient->getSessionToken();$credentials = $stsClient->createCredentials($result);

58

AWS SDK pour PHP Manuel du développeurInformations d’identification codées en dur

$s3Client = new S3Client([ 'version' => '2006-03-01', 'region' => 'us-west-2', 'credentials' => $credentials]);

Pour plus d’informations sur les raisons pour lesquelles vous pouvez avoir besoin d’utiliser des informationsd’identification temporaires dans l’application ou le projet, consultez la section Scénarios d’autorisation d’unaccès temporaire dans la documentation AWS STS.

Utilisation d’informations d’identification codées en durLors du test de nouveaux services ou du débogage des problèmes, les développeurs demandent souventà inclure les informations d’identification AWS lors de la création du client. Consultez les éléments suivantspour savoir comment s’authentifier auprès d’AWS avec précaution. La section Informations d’identificationpour le kit AWS SDK pour PHP version 3 (p. 42) répertorie de nombreuses façons recommandéespermettant d’ajouter les informations d’identification à votre projet en toute sécurité.

Warning

Coder en dur les informations d'identification peut s'avérer dangereux, car il est facile de valideraccidentellement les informations d'identification dans un référentiel SCM. L’ajout d’informationsd’identification directement dans votre code de production peut exposer vos informationsd’identification à un plus grand nombre de personnes que prévu. Ceci peut également rendredifficile la future rotation d'informations d'identification.

Si vous décidez de coder en dur les informations d'identification pour un client SDK, fournissez unensemble de paires clé-valeur « clé », « secret » et « jeton » à l'option « informations d'identification » d'unconstructeur client.

// Hard-coded credentials$s3Client = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => [ 'key' => 'my-access-key-id', 'secret' => 'my-secret-access-key', ],]);

Création de clients anonymesDans certains cas, il se peut que vous souhaitiez créer un client qui n'est associé à aucune informationd'identification. Ceci vous permet d'effectuer des demandes anonymes à un service.

Par exemple, vous pouvez configurer les objets Amazon S3 et les domaines Amazon CloudSearch pourautoriser un accès anonyme.

Pour créer un client anonyme, vous pouvez définir l'option 'credentials' sur false.

$s3Client = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => false]);

// Makes an anonymous request. The object would need to be publicly// readable for this to succeed.$result = $s3Client->getObject([

59



AWS SDK pour PHP Manuel du développeurObjets de commande

'Bucket' => 'my-bucket', 'Key' => 'my-key',]);

Objets de commande dans le kit AWS SDK for PHPversion 3

Le kit AWS SDK for PHP utilise le modèle de commande pour encapsuler les paramètres et le gestionnairequi sera utilisé pour transférer une demande HTTP ultérieurement.

Utilisation de commandes impliciteSi vous examinez une classe client, vous constaterez que les méthodes correspondant aux opérationsd'API n'existent pas réellement. Elles sont implémentées à l'aide de la méthode magique __call(). Cespseudo-méthodes sont en réalité des raccourcis qui encapsulent l'utilisation des objets de commande parle kit SDK.

Vous n'avez généralement pas besoin d'interagir directement avec les objets de commande. Lorsquevous appelez des méthodes telles que Aws\S3\S3Client::putObject(), le kit SDK crée un objetAws\CommandInterface en fonction des paramètres fournis, exécute la commande et renvoie un objetAws\ResultInterface renseigné (ou lève une exception en cas d'erreur). Un flux similaire se produitlorsqu'une des méthodes Async d'un client (par exemple, Aws\S3\S3Client::putObjectAsync()) estappelée : le client crée une commande en fonction des paramètres fournis, sérialise une demande HTTP,initie la demande et renvoie une promesse.

Les exemples suivants sont équivalents d'un point de vue fonctionnel.

$s3Client = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-standard']);

$params = [ 'Bucket' => 'foo', 'Key' => 'baz', 'Body' => 'bar'];

// Using operation methods creates a command implicitly$result = $s3Client->putObject($params);

// Using commands explicitly$command = $s3Client->getCommand('PutObject', $params);$result = $s3Client->execute($command);

Paramètres de commandeToutes les commandes prennent en charge un certain nombre de paramètres spéciaux qui ne font paspartie de l'API d'un service, mais contrôlent le comportement du kit SDK.

@httpVous pouvez, à l'aide de ce paramètre, ajuster la manière dont le gestionnaire HTTP sous-jacent exécutela demande. Vous pouvez inclure dans le paramètre @http les mêmes options que celles définies lors del'instanciation du client à l'aide de l'option client « http » (p. 32).

60

http://en.wikipedia.org/wiki/Command_pattern

AWS SDK pour PHP Manuel du développeurCréation d'objets de commande

// Configures the command to be delayed by 500 milliseconds$command['@http'] = [ 'delay' => 500,];

@retriesComme l'option client « retries » (p. 39), @retries (nouvelles tentatives) contrôle le nombre de fois oùune commande peut être relancée avant que celle-ci ne soit considérée comme ayant échoué. Définissez-la sur 0 pour désactiver les nouvelles tentatives.

// Disable retries$command['@retries'] = 0;

Note

Si vous avez désactivé les nouvelles tentatives sur un client, vous ne pouvez pas les activer demanière sélective sur des commandes individuelles transmises à ce client.

Création d'objets de commandeVous pouvez créer une commande à l'aide de la méthode getCommand() d'un client. Une demande HTTPne sera pas immédiatement exécutée ou transférée. L'exécution de la demande ne sera effectuée qu'unefois la commande transmise à la méthode execute() du client. Vous avez ainsi la possibilité de modifierl'objet de commande avant d'exécuter la commande.

$command = $s3Client->getCommand('ListObjects');$command['MaxKeys'] = 50;$command['Prefix'] = 'foo/baz/';$result = $s3Client->execute($command);

// You can also modify parameters$command = $s3Client->getCommand('ListObjects', [ 'MaxKeys' => 50, 'Prefix' => 'foo/baz/',]);$command['MaxKeys'] = 100;$result = $s3Client->execute($command);

Commande HandlerListLorsqu'une commande est créée à partir d'un client, elle reçoit un clone de l'objet Aws\HandlerList duclient. La commande reçoit un clone de la liste des gestionnaires du client pour autoriser une commandeà utiliser un intergiciel et des gestionnaires personnalisés qui n'affectent pas les autres commandesexécutées par le client.

Cela signifie que vous pouvez utiliser un client HTTP différent par commande (par exemple, Aws\MockHandler) et ajouter un comportement personnalisé par commande via l'intergiciel. L'exemplesuivant utilise un MockHandler pour créer des résultats fictifs au lieu d'envoyer des demandes HTTPréelles.

use Aws\Result;use Aws\MockHandler;

// Create a mock handler$mock = new MockHandler();// Enqueue a mock result to the handler$mock->append(new Result(['foo' => 'bar']));

61

AWS SDK pour PHP Manuel du développeurCommandPool

// Create a "ListObjects" command$command = $s3Client->getCommand('ListObjects');// Associate the mock handler with the command$command->getHandlerList()->setHandler($mock);// Executing the command will use the mock handler, which returns the// mocked result object$result = $client->execute($command);

echo $result['foo']; // Outputs 'bar'

En plus de changer le gestionnaire utilisé par la commande, vous pouvez également injecter un intergicielpersonnalisé dans la commande. L'exemple suivant utilise l'intergiciel tap, qui fonctionne commeobservateur dans la liste des gestionnaires.

use Aws\CommandInterface;use Aws\Middleware;use Psr\Http\Message\RequestInterface;

$command = $s3Client->getCommand('ListObjects');$list = $command->getHandlerList();

// Create a middleware that just dumps the command and request that is// about to be sent$middleware = Middleware::tap( function (CommandInterface $command, RequestInterface $request) { var_dump($command->toArray()); var_dump($request); });

// Append the middleware to the "sign" step of the handler list. The sign// step is the last step before transferring an HTTP request.$list->append('sign', $middleware);

// Now transfer the command and see the var_dump data$s3Client->execute($command);

CommandPoolLe Aws\CommandPool vous permet d'exécuter des commandes simultanément à l'aide d'un itérateurgénérant des objets Aws\CommandInterface. Le CommandPool veille à ce qu'un nombre constant decommandes soient exécutées simultanément pendant l'itération sur les commandes du groupe (à mesureque les commandes se terminent, d'autres sont exécutées pour garantir une taille de groupe constante).

Voici un exemple très simple illustrant l'envoi de quelques commandes à l'aide d'un CommandPool.

use Aws\S3\S3Client;use Aws\CommandPool;

// Create the client$client = new S3Client([ 'region' => 'us-standard', 'version' => '2006-03-01']);

$bucket = 'example';$commands = [ $client->getCommand('HeadObject', ['Bucket' => $bucket, 'Key' => 'a']), $client->getCommand('HeadObject', ['Bucket' => $bucket, 'Key' => 'b']), $client->getCommand('HeadObject', ['Bucket' => $bucket, 'Key' => 'c'])];

62


$pool = new CommandPool($client, $commands);

// Initiate the pool transfers$promise = $pool->promise();

// Force the pool to complete synchronously$promise->wait();

Cet exemple est relativement peu puissant pour le CommandPool. Essayons un exemple plus complexe.Supposons que vous souhaitiez charger des fichiers présents sur un disque vers un compartiment AmazonS3. Pour obtenir une liste des fichiers à partir du disque, nous pouvons utiliser le DirectoryIterator dePHP. Cet itérateur génère des objets SplFileInfo. Le CommandPool accepte un itérateur générant desobjets Aws\CommandInterface. Nous devons donc mapper les objets SplFileInfo pour renvoyer desobjets Aws\CommandInterface.

<?phprequire 'vendor/autoload.php';

use Aws\Exception\AwsException;use Aws\S3\S3Client;use Aws\CommandPool;use Aws\CommandInterface;use Aws\ResultInterface;use GuzzleHttp\Promise\PromiseInterface;

// Create the client$client = new S3Client([ 'region' => 'us-standard', 'version' => '2006-03-01']);

$fromDir = '/path/to/dir';$toBucket = 'my-bucket';

// Create an iterator that yields files from a directory$files = new DirectoryIterator($fromDir);

// Create a generator that converts the SplFileInfo objects into// Aws\CommandInterface objects. This generator accepts the iterator that// yields files and the name of the bucket to upload the files to.$commandGenerator = function (\Iterator $files, $bucket) use ($client) { foreach ($files as $file) { // Skip "." and ".." files if ($file->isDot()) { continue; } $filename = $file->getPath() . '/' . $file->getFilename(); // Yield a command that is executed by the pool yield $client->getCommand('PutObject', [ 'Bucket' => $bucket, 'Key' => $file->getBaseName(), 'Body' => fopen($filename, 'r') ]); }};

// Now create the generator using the files iterator$commands = $commandGenerator($files, $toBucket);

// Create a pool and provide an optional array of configuration$pool = new CommandPool($client, $commands, [ // Only send 5 files at a time (this is set to 25 by default) 'concurrency' => 5, // Invoke this function before executing each command

63


'before' => function (CommandInterface $cmd, $iterKey) { echo "About to send {$iterKey}: " . print_r($cmd->toArray(), true) . "\n"; }, // Invoke this function for each successful transfer 'fulfilled' => function ( ResultInterface $result, $iterKey, PromiseInterface $aggregatePromise ) { echo "Completed {$iterKey}: {$result}\n"; }, // Invoke this function for each failed transfer 'rejected' => function ( AwsException $reason, $iterKey, PromiseInterface $aggregatePromise ) { echo "Failed {$iterKey}: {$reason}\n"; },]);

// Initiate the pool transfers$promise = $pool->promise();

// Force the pool to complete synchronously$promise->wait();

// Or you can chain the calls off of the pool$promise->then(function() { echo "Done\n"; });

Configuration du CommandPoolLe constructeur Aws\CommandPool accepte différentes options de configuration.

concurrency (callable|int)

Nombre maximal de commandes pouvant être exécutées simultanément. Fournissez une fonction pourredimensionner le groupe de manière dynamique. La fonction reçoit le nombre actuel de demandes enattente et devrait renvoyer un nombre entier représentant la nouvelle limite de taille du groupe.

before (callable)

Fonction à appeler avant d'envoyer chaque commande. La fonction before accepte la commande etla clé de l'itérateur de la commande. Vous pouvez muter la commande, si nécessaire, dans la fonctionbefore avant d'envoyer la commande.

fulfilled (callable)

Fonction à appeler lorsqu'une promesse est exécutée. La fonction reçoit l'objet de résultat, l'ID del'itérateur à partir duquel provient le résultat et la promesse agrégée pouvant être résolue ou rejetée sivous devez court-circuiter le groupe.

rejected (callable)

Fonction à appeler lorsqu'une promesse est rejetée. La fonction reçoit un objet Aws\Exception,l'ID de l'itérateur à partir duquel provient l'exception et la promesse agrégée pouvant être résolue ourejetée si vous devez court-circuiter le groupe.

Nettoyage de mémoire manuel entre des commandesSi vous atteignez la limite de mémoire lors de groupes de commandes volumineux, c'est peut-être parceque des références cycliques générées par le kit SDK n'ont pas encore été traitées par le nettoyage de

64

https://www.php.net/manual/en/features.gc.php/

AWS SDK pour PHP Manuel du développeurPromesses

mémoire de PHP. L'appel manuel de l'algorithme de nettoyage entre les commandes peut permettre letraitement des cycles avant que cette limite ne soit atteinte. L'exemple suivant crée un CommandPoolqui appelle l'algorithme de nettoyage en utilisant un rappel avant l'envoi de chaque commande. Notezque l'appel du nettoyage de mémoire représente un coût en termes de performances, et que l'utilisationoptimale dépendra de votre cas d'utilisation et de l'environnement.

$pool = new CommandPool($client, $commands, [ 'concurrency' => 25, 'before' => function (CommandInterface $cmd, $iterKey) { gc_collect_cycles(); }]);

Promesses dans le kit AWS SDK for PHP version 3Le kit AWS SDK for PHP utilise les promesses pour permettre les flux de travail asynchrones. Cetteasynchronicité rend possible l’envoi simultané de demandes HTTP. La spécification de promesse utiliséepar le kit SDK est Promesses/A+.

Qu'est-ce qu'une promesse ?Une promesse représente le résultat final d’une opération asynchrone. Le principal moyen d'interagir avecune promesse est via sa méthode then. Cette méthode enregistre les rappels pour recevoir la valeur finaled'une promesse ou la raison pour laquelle la promesse ne peut pas être exécutée.

Le kit AWS SDK for PHP s’appuie sur le package Composer guzzlehttp/promesses pour sonimplémentation de promesses. Les promesses Guzzle prennent en charge les flux de travail bloquants etnon bloquants, et peuvent être utilisées avec n'importe quelle boucle d'événements non bloquants.

Note

Les demandes HTTP sont envoyées simultanément dans le kit AWS SDK for PHP à l'aide d'unseul thread, dans lequel les appels non bloquants sont utilisés pour transférer une ou plusieursdemandes HTTP tout en réagissant aux changements d'état (par exemple : exécution ou rejet depromesses).

Promesses dans le kit SDKLes promesses sont utilisées dans l'ensemble du kit SDK. Par exemple, les promesses sontutilisées dans la plupart des abstractions de haut niveau fournies par le kit SDK : les programmes depagination (p. 82), les programmes d’attente (p. 84), les groupes de commande (p. 62), leschargements partitionnés (p. 220), les transferts de répertoires/de compartiments S3 (p. 111), etc.

Tous les clients fournis par le kit SDK renvoient des promesses lorsque vous appelez l'une des méthodessuffixées Async. Par exemple, le code suivant montre comment créer une promesse pour obtenir lesrésultats d’une opération Amazon DynamoDBDescribeTable.

$client = new Aws\DynamoDb\DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest',]);

// This will create a promise that will eventually contain a result$promise = $client->describeTableAsync(['TableName' => 'mytable']);

65


https://promisesaplus.com/

https://github.com/guzzle/promises

AWS SDK pour PHP Manuel du développeurPromesses dans le kit SDK

Notez que vous pouvez appeler describeTable ou describeTableAsync. Ces méthodes sontdes méthodes __call magiques utilisées sur un client et alimentées par le modèle d'API et le numéroversion associé au client. En appelant des méthodes telles que describeTable sans le suffixe Async,le client se bloquera pendant l'envoi d'une demande HTTP et renverra un objet Aws\ResultInterfaceou lèvera une Aws\Exception\AwsException. En ajoutant le suffixe Async au nom de l'opération(c.-à-d. describeTableAsync), le client créera une promesse qui sera exécutée avec un objet Aws\ResultInterface ou rejetée avec un Aws\Exception\AwsException.

Important

Lorsque la promesse est renvoyée, le résultat est peut-être déjà arrivé (par exemple, lors del'utilisation d'un gestionnaire fictif), ou la demande HTTP n'a peut-être pas été initiée.

Vous pouvez enregistrer un rappel avec la promesse en utilisant la méthode then. Cette méthode acceptedeux rappels, $onFulfilled et $onRejected, tous deux facultatifs. Le rappel $onFulfilled estappelé si la promesse est exécutée, et le rappel $onRejected est appelé si la promesse est rejetée (c.-à-d. en cas d'échec).

$promise->then( function ($value) { echo "The promise was fulfilled with {$value}"; }, function ($reason) { echo "The promise was rejected with {$reason}"; });

Exécution de commandes simultanéesPlusieurs promesses peuvent être composées conjointement de manière à être exécutées simultanément.Cette action peut être réalisée en intégrant le kit SDK à une boucle d'événements non bloquants, ou engénérant plusieurs promesses et en attendant qu'elles se terminent simultanément.

use GuzzleHttp\Promise;

$sdk = new Aws\Sdk([ 'version' => 'latest', 'region' => 'us-west-2']);

$s3 = $sdk->createS3();$ddb = $sdk->createDynamoDb();

$promises = [ 'buckets' => $s3->listBucketsAsync(), 'tables' => $ddb->listTablesAsync(),];

// Wait on both promises to complete and return the results$results = Promise\unwrap($promises);

// Notice that this method will maintain the input array keysvar_dump($results['buckets']->toArray());var_dump($results['tables']->toArray());

Note

Le CommandPool (p. 62) fournit un mécanisme plus puissant permettant d’exécuter plusieursopérations d’API simultanément.

66

AWS SDK pour PHP Manuel du développeurChaînage de promesses

Chaînage de promessesL'un des principaux avantages des promesses est qu'elles sont composables, vous permettant ainsi decréer des pipelines de transformation. Les promesses sont composées en créant des chaînes de rappelsthen, suivis de rappels then. La valeur de retour d'une méthode then est une promesse qui est exécutéeou rejetée en fonction du résultat des rappels fournis.

$promise = $client->describeTableAsync(['TableName' => 'mytable']);

$promise ->then( function ($value) { $value['AddedAttribute'] = 'foo'; return $value; }, function ($reason) use ($client) { // The call failed. You can recover from the error here and // return a value that will be provided to the next successful // then() callback. Let's retry the call. return $client->describeTableAsync(['TableName' => 'mytable']); } )->then( function ($value) { // This is only invoked when the previous then callback is // fulfilled. If the previous callback returned a promise, then // this callback is invoked only after that promise is // fulfilled. echo $value['AddedAttribute']; // outputs "foo" }, function ($reason) { // The previous callback was rejected (failed). } );

Note

La valeur de retour d'un rappel de promesse est l'argument $value fourni aux promesses en aval.Si vous souhaitez fournir une valeur aux chaînes de promesses en aval, vous devez renvoyer unevaleur dans la fonction de rappel.

Transmission de rejetVous pouvez enregistrer un rappel à appeler lorsqu'une promesse est rejetée. Si une exception est levéedans un rappel, la promesse est rejetée avec l'exception et les promesses suivantes de la chaîne sontrejetées avec l'exception. Si une valeur est renvoyée à partir d'un rappel $onRejected, les promessessuivantes de la chaîne de promesse sont exécutées avec la valeur de retour du rappel $onRejected.

Attente des promessesVous pouvez forcer des promesses à s'exécuter de manière synchrone en utilisant la méthode wait d'unepromesse.

$promise = $client->listTablesAsync();$result = $promise->wait();

Si une exception se produit lors de l'appel de la fonction wait d'une promesse, la promesse est rejetéeavec l'exception et l'exception est levée.


67

AWS SDK pour PHP Manuel du développeurAnnulation des promesses

$promise = $client->listTablesAsync();

try { $result = $promise->wait();} catch (AwsException $e) { // Handle the error}

L'appel de la méthode wait d'une promesse qui a été exécutée ne déclenche pas la fonction wait. Celarenvoie simplement la valeur précédemment fournie.

$promise = $client->listTablesAsync();$result = $promise->wait();assert($result ### $promise->wait());

Appeler la méthode wait d'une promesse qui a été rejetée lève une exception. Si la raison durejet est une instance de \Exception, la raison est levée. Sinon, une GuzzleHttp\Promise\RejectionException est levée et la raison peut être obtenue en appelant la méthode getReason del'exception.

Note

Les appels d’opérations d’API dans le kit AWS SDK for PHP sont rejetés avec les sous-classesde la classe Aws\Exception\AwsException. Toutefois, la raison fournie à une méthode thenpeut être différente en raison de l'ajout d'un intergiciel personnalisé modifiant une raison de rejet.

Annulation des promessesLes promesses peuvent être annulées à l'aide de la méthode cancel() d'une promesse. Si une promessea déjà été résolue, appeler cancel() n'aura aucun effet. L'annulation d'une promesse annule la promesseet toutes les promesses en attente de la livraison de la promesse. Un promesse annulée est rejetée avecune GuzzleHttp\Promise\RejectionException.

Combinaison des promessesVous pouvez combiner des promesses dans des promesses agrégées afin de créer des flux de travail plussophistiqués. Le package guzzlehttp/promise contient différentes fonctions que vous pouvez utiliserpour combiner des promesses.

Vous trouverez la documentation de l’API pour toutes les fonctions de collecte de promesses surnamespace-GuzzleHttp.Promise.

each et each_limitUtilisez le CommandPool (p. 62) lorsqu’une file d’attente de tâches de commandes Aws\CommandInterface doit être exécutée simultanément avec une taille de groupe fixe (les commandespeuvent être en mémoire ou générées par un itérateur paresseux). Le CommandPool veille à ce qu'unnombre fixe de commandes soit envoyées simultanément jusqu'à ce que l'itérateur fourni soit épuisé.

Le CommandPool fonctionne uniquement avec les commandes exécutées par le même client. Vouspouvez utiliser la fonction GuzzleHttp\Promise\each_limit pour effectuer des commandes d'envoide différents clients simultanément avec une taille de groupe fixe.


$sdk = new Aws\Sdk([ 'version' => 'latest', 'region' => 'us-west-2'

68

https://docs.aws.amazon.com/aws-sdk-php/v3/api//namespace-GuzzleHttp.Promise.html

AWS SDK pour PHP Manuel du développeurCombinaison des promesses

]);

$s3 = $sdk->createS3();$ddb = $sdk->createDynamoDb();

// Create a generator that yields promises$promiseGenerator = function () use ($s3, $ddb) { yield $s3->listBucketsAsync(); yield $ddb->listTablesAsync(); // yield other promises as needed...};

// Execute the tasks yielded by the generator concurrently while limiting the// maximum number of concurrent promises to 5$promise = Promise\each_limit($promiseGenerator(), 5);

// Waiting on an EachPromise will wait on the entire task queue to complete$promise->wait();

Coroutines de promesseLa bibliothèque de promesses Guzzle propose une fonction particulièrement puissante qui autorisel'utilisation des coroutines de promesses rendant l'écriture de flux de travail asynchrones plus semblable àcelle de flux de travail synchrones classiques. En effet, le kit AWS SDK for PHP utilise les promesses decoroutine dans la plupart des abstractions de haut niveau.

Supposons que vous souhaitiez créer plusieurs compartiments, charger un fichier dans le compartimentune fois ce dernier disponible et effectuer ces actions simultanément pour bénéficier d'un processus aussirapide que possible. Pour ce faire, combinez simplement plusieurs promesses de coroutine à l'aide de lafonction de promesse all().


$uploadFn = function ($bucket) use ($s3Client) { return Promise\coroutine(function () use ($bucket, $s3Client) { // You can capture the result by yielding inside of parens $result = (yield $s3Client->createBucket(['Bucket' => $bucket])); // Wait on the bucket to be available $waiter = $s3Client->getWaiter('BucketExists', ['Bucket' => $bucket]); // Wait until the bucket exists yield $waiter->promise(); // Upload a file to the bucket yield $s3Client->putObjectAsync([ 'Bucket' => $bucket, 'Key' => '_placeholder', 'Body' => 'Hi!' ]); });};

// Create the following buckets$buckets = ['foo', 'baz', 'bar'];$promises = [];

// Build an array of promisesforeach ($buckets as $bucket) { $promises[] = $uploadFn($bucket);}

// Aggregate the promises into a single "all" promise$aggregate = Promise\all($promises);

// You can then() off of this promise or synchronously wait

69

AWS SDK pour PHP Manuel du développeurGestionnaires et intergiciels

$aggregate->wait();

Gestionnaires et intergiciel dans le kit AWS SDK forPHP version 3

La principale méthode utilisée pour développer le kit AWS SDK for PHP consiste à utiliser desgestionnaires et des intergiciels. Chaque classe de client de kit SDK possède une instance Aws\HandlerList accessible via la méthode getHandlerList() d'un client. Vous pouvez récupérer laHandlerList d'un client et la modifier afin d'ajouter ou de supprimer un comportement client.

GestionnairesUn gestionnaire est une fonction qui transforme une commande et une requête en un résultat. Il envoiegénéralement des requêtes HTTP. Les gestionnaires peuvent comporter des intergiciels, qui renforcentleur comportement. Un gestionnaire est une fonction qui accepte un Aws\CommandInterface etun Psr\Http\Message\RequestInterface, et renvoie une promesse exécutée avec un Aws\ResultInterface ou rejetée avec une raison Aws\Exception\AwsException.

Voici un gestionnaire qui renvoie le même résultat fictif pour chaque appel.

use Aws\CommandInterface;use Aws\Result;use Psr\Http\Message\RequestInterface;use GuzzleHttp\Promise;

$myHandler = function (CommandInterface $cmd, RequestInterface $request) { $result = new Result(['foo' => 'bar']); return Promise\promise_for($result);};

Vous pouvez utiliser ce gestionnaire avec un client de kit SDK en spécifiant une option handler dans leconstructeur du client.

// Set the handler of the client in the constructor$s3 = new Aws\S3\S3Client([ 'region' => 'us-east-1', 'version' => '2006-03-01', 'handler' => $myHandler]);

Vous pouvez également modifier le gestionnaire existant d'un client à l'aide de la méthode setHandler deAws\ClientInterface.

// Set the handler of the client after it is constructed$s3->getHandlerList()->setHandler($myHandler);

Mock HandlerNous vous recommandons d'utiliser MockHandler lorsque vous écrivez des tests qui utilisent le kitSDK. Aws\MockHandler vous permet de renvoyer des résultats fictifs ou de lancer des exceptions desimulation. Dans ce cas, vous mettez en file d'attente les résultats ou les exceptions, puis MockHandler lesretire de la file d'attente dans l'ordre FIFO.

use Aws\Result;

70

AWS SDK pour PHP Manuel du développeurIntergiciel

use Aws\MockHandler;use Aws\DynamoDb\DynamoDbClient;use Aws\CommandInterface;use Psr\Http\Message\RequestInterface;use Aws\Exception\AwsException;

$mock = new MockHandler();

// Return a mocked result$mock->append(new Result(['foo' => 'bar']));

// You can provide a function to invoke; here we throw a mock exception$mock->append(function (CommandInterface $cmd, RequestInterface $req) { return new AwsException('Mock exception', $cmd);});

// Create a client with the mock handler$client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'handler' => $mock]);

// Result object response will contain ['foo' => 'bar']$result = $client->listTables();

// This will throw the exception that was enqueued$client->listTables();

IntergicielUn intergiciel est un type spécial de fonction de haut niveau qui augmente le comportement de transfertd'une commande et délègue la tâche à un gestionnaire « suivant ». Les fonctions d'intergiciel acceptentun Aws\CommandInterface et un Psr\Http\Message\RequestInterface, et renvoient unepromesse exécutée avec un Aws\ResultInterface ou rejetée avec une raison Aws\Exception\AwsException.

Un intergiciel est une fonction supérieure qui modifie les commandes, les requêtes ou les résultats qu'iltraite. Un intergiciel se présente sous la forme suivante.

use Aws\CommandInterface;use Psr\Http\Message\RequestInterface;

$middleware = function () { return function (callable $handler) use ($fn) { return function ( CommandInterface $command, RequestInterface $request = null ) use ($handler, $fn) { // Do something before calling the next handler // ... $promise = $fn($command, $request); // Do something in the promise after calling the next handler // ... return $promise; }; };};

Un intergiciel reçoit une commande à exécuter et un objet de requête facultatif. Il peut choisir d'augmenterla requête et la commande ou de les laisser en l'état. Un intergiciel appelle le gestionnaire suivant de lachaîne ou choisit de le court-circuiter et de renvoyer une promesse. La promesse ainsi créée en appelant

71


le gestionnaire suivant peut alors être augmentée à l'aide de la méthode then de la promesse afin demodifier le résultat ou l'erreur avant le renvoi de la promesse à la pile d'intergiciels.

HandlerListLe kit SDK utilise Aws\HandlerList pour gérer les intergiciels et les gestionnaires utilisés lors del'exécution d'une commande. Chaque client du kit SDK possède une HandlerList. Cette HandlerListest clonée et ajoutée à chaque commande créée par un client. Vous pouvez attacher un intergiciel et ungestionnaire par défaut à utiliser pour chaque commande créée par un client en ajoutant un intergiciel àla HandlerList du client. Vous pouvez ajouter et supprimer des intergiciels de certaines commandesspécifiques en modifiant la HandlerList appartenant à une commande spécifique.

HandlerList représente une pile d’intergiciels utilisés pour encapsuler un gestionnaire. Pour vous aider àgérer la liste d'intergiciels et l'ordre dans lequel ils encapsulent un gestionnaire, HandlerList divise la piled'intergiciels en plusieurs étapes nommées qui représentent une partie du cycle de vie du transfert d'unecommande :

1. init - Ajout des paramètres par défaut2. validate - Validation des paramètres obligatoires3. build - Sérialisation d'une requête HTTP pour envoi4. sign - Signature de la requête HTTP sérialisée5. <handler> (il ne s’agit pas ici d’une étape, mais du transfert lui-même)

init

Cette étape du cycle de vie représente l'initialisation d'une commande. La requête n'a pas encoreété sérialisée. Cette étape est généralement utilisée pour ajouter des paramètres par défaut à unecommande.

Vous pouvez ajouter un intergiciel à l'étape init à l'aide des méthodes appendInit etprependInit, où appendInit ajoute l'intergiciel à la fin de la liste prepend, et où prependInitajoute l'intergiciel au début de la liste prepend.

use Aws\Middleware;

$middleware = Middleware::tap(function ($cmd, $req) { // Observe the step});

// Append to the end of the step with a custom name$client->getHandlerList()->appendInit($middleware, 'custom-name');// Prepend to the beginning of the step$client->getHandlerList()->prependInit($middleware, 'custom-name');

valider

Cette étape du cycle de vie permet de valider les paramètres d'entrée d'une commande.

Vous pouvez ajouter un intergiciel à l'étape validate à l'aide des méthodes appendValidate etprependValidate, où appendValidate ajoute l'intergiciel à la fin de la liste validate, et oùprependValidate ajoute l'intergiciel au début de la liste validate.

use Aws\Middleware;


72


// Append to the end of the step with a custom name$client->getHandlerList()->appendValidate($middleware, 'custom-name');// Prepend to the beginning of the step$client->getHandlerList()->prependValidate($middleware, 'custom-name');

build

Cette étape du cycle de vie permet de sérialiser une requête HTTP pour la commande en coursd'exécution. Les événements du cycle de vie en aval recevront une commande et une requête HTTPPSR-7.

Vous pouvez ajouter un intergiciel à l'étape build à l'aide des méthodes appendBuild etprependBuild, où appendBuild ajoute l'intergiciel à la fin de la liste build, et où prependBuildajoute l'intergiciel au début de la liste build.

use Aws\Middleware;


// Append to the end of the step with a custom name$client->getHandlerList()->appendBuild($middleware, 'custom-name');// Prepend to the beginning of the step$client->getHandlerList()->prependBuild($middleware, 'custom-name');

sign

Cette étape du cycle de vie est généralement utilisée pour signer les requêtes HTTP avant leur envoisur le réseau. De manière générale, nous vous recommandons d'éviter de muter une requête HTTPqui a déjà été signée afin d'éviter les erreurs de signature.

Il s'agit de la dernière étape de HandlerList avant le transfert de la requête HTTP par ungestionnaire.

Vous pouvez ajouter un intergiciel à l'étape sign à l'aide des méthodes appendSign etprependSign, où appendSign ajoute l'intergiciel à la fin de la liste sign, et où prependSign ajoutel'intergiciel au début de la liste sign.

use Aws\Middleware;


// Append to the end of the step with a custom name$client->getHandlerList()->appendSign($middleware, 'custom-name');// Prepend to the beginning of the step$client->getHandlerList()->prependSign($middleware, 'custom-name');

Intergiciels disponiblesLe kit SDK comporte plusieurs intergiciels que vous pouvez utiliser pour augmenter le comportement d'unclient ou pour observer l'exécution d'une commande.

mapCommandL'intergiciel Aws\Middleware::mapCommand vous permet de modifier une commande avant qu'ellene soit sérialisée en tant que requête HTTP. Par exemple, vous pouvez utiliser mapCommand pour

73


effectuer une validation ou pour ajouter des paramètres par défaut. La fonction mapCommand accepteune fonction de type callable, qui accepte un objet Aws\CommandInterface et renvoie un objet Aws\CommandInterface.

use Aws\Middleware;use Aws\CommandInterface;

// Here we've omitted the require Bucket parameter. We'll add it in the// custom middleware.$command = $s3Client->getCommand('HeadObject', ['Key' => 'test']);

// Apply a custom middleware named "add-param" to the "init" lifecycle step$command->getHandlerList()->appendInit( Middleware::mapCommand(function (CommandInterface $command) { $command['Bucket'] = 'mybucket'; // Be sure to return the command! return $command; }), 'add-param');

mapRequestL'intergiciel Aws\Middleware::mapRequest vous permet de modifier une requête après sa sérialisation,mais avant son envoi. Vous pouvez par exemple l'utiliser pour ajouter des en-têtes HTTP personnalisés àune requête. La fonction mapRequest accepte une fonction de type callable, qui accepte un argument Psr\Http\Message\RequestInterface et renvoie un objet Psr\Http\Message\RequestInterface.

use Aws\Middleware;use Psr\Http\Message\RequestInterface;

// Create a command so that we can access the handler list$command = $s3Client->getCommand('HeadObject', [ 'Key' => 'test', 'Bucket' => 'mybucket']);

// Apply a custom middleware named "add-header" to the "build" lifecycle step$command->getHandlerList()->appendBuild( Middleware::mapRequest(function (RequestInterface $request) { // Return a new request with the added header return $request->withHeader('X-Foo-Baz', 'Bar'); }), 'add-header');

Désormais, lorsque la commande est exécutée, elle est envoyée avec l'en-tête personnalisé.Important

Notez que l'intergiciel a été ajouté à la liste des gestionnaires à la fin de l'étape build. Celapermet de s'assurer qu'une requête a été créée avant l'appel de cet intergiciel.

mapResultL'intergiciel Aws\Middleware::mapResult permet de modifier le résultat de l'exécution d'unecommande. La fonction mapResult accepte une fonction de type callable, qui accepte un argument Aws\ResultInterface et renvoie un objet Aws\ResultInterface.

use Aws\Middleware;use Aws\ResultInterface;

74


$command = $s3Client->getCommand('HeadObject', [ 'Key' => 'test', 'Bucket' => 'mybucket']);

$command->getHandlerList()->appendSign( Middleware::mapResult(function (ResultInterface $result) { // Add a custom value to the result $result['foo'] = 'bar'; return $result; }));

Désormais, lorsque la commande est exécutée, le résultat renvoyé contient un attribut foo.

history

L'intergiciel history permet de vérifier que le kit SDK a bien exécuté les commandes attendues, qu'il abien envoyé les requêtes HTTP spécifiées, et qu'il a bien reçu les résultats escomptés. Globalement, il agitde manière similaire à l'historique d'un navigateur web.

use Aws\History;use Aws\Middleware;

$ddb = new Aws\DynamoDb\DynamoDbClient([ 'version' => 'latest', 'region' => 'us-west-2']);

// Create a history container to store the history data$history = new History();

// Add the history middleware that uses the history container$ddb->getHandlerList()->appendSign(Middleware::history($history));

Un conteneur d'historique Aws\History stocke 10 entrées par défaut avant de purger ses entrées. Vouspouvez personnaliser le nombre d'entrées en indiquant combien le constructeur peut en recevoir.

// Create a history container that stores 20 entries$history = new History(20);

Vous pouvez inspecter le conteneur d'historique après l'exécution de requêtes traitées par l'intergicield'historique.

// The object is countable, returning the number of entries in the containercount($history);

// The object is iterable, yielding each entry in the containerforeach ($history as $entry) { // You can access the command that was executed var_dump($entry['command']); // The request that was serialized and sent var_dump($entry['request']); // The result that was received (if successful) var_dump($entry['result']); // The exception that was received (if a failure occurred) var_dump($entry['exception']);}

// You can get the last Aws\CommandInterface that was executed. This method

75

AWS SDK pour PHP Manuel du développeurCréation de gestionnaires personnalisés

// will throw an exception if no commands have been executed.$command = $history->getLastCommand();

// You can get the last request that was serialized. This method will throw an exception// if no requests have been serialized.$request = $history->getLastRequest();

// You can get the last return value (an Aws\ResultInterface or Exception).// The method will throw an exception if no value has been returned for the last// executed operation (e.g., an async request has not completed).$result = $history->getLastReturn();

// You can clear out the entries using clear$history->clear();

tap

L'intergiciel tap fonctionne comme un observateur. Vous pouvez l'utiliser pour appeler des fonctions lorsde l'envoi de commandes via la chaîne d'intergiciels. La fonction tap accepte une fonction de type callablequi accepte Aws\CommandInterface et une option Psr\Http\Message\RequestInterface en coursd'exécution (facultatif).

use Aws\Middleware;

$s3 = new Aws\S3\S3Client([ 'region' => 'us-east-1', 'version' => '2006-03-01']);

$handlerList = $s3->getHandlerList();

// Create a tap middleware that observes the command at a specific step$handlerList->appendInit( Middleware::tap(function (CommandInterface $cmd, RequestInterface $req = null) { echo 'About to send: ' . $cmd->getName() . "\n"; if ($req) { echo 'HTTP method: ' . $request->getMethod() . "\n"; } });

Création de gestionnaires personnalisésUn gestionnaire est une fonction qui accepte des objets Aws\CommandInterface et Psr\Http\Message\RequestInterface, et renvoie une promesse GuzzleHttp\Promise\PromiseInterface exécutée avec Aws\ResultInterface ou rejetée avec Aws\Exception\AwsException.

Même si le kit SDK possède plusieurs options @http, un gestionnaire n'a besoin de savoir utiliser que lesoptions suivantes :

• connect_timeout (p. 32)• debug (p. 33)• decode_content (p. 33) (facultatif)• delay (p. 33)• progress (p. 34) (facultatif)• proxy (p. 35)• sink (p. 35)

76

AWS SDK pour PHP Manuel du développeurStreams

• synchronous (p. 36) (facultatif)• stream (p. 36) (facultatif)• timeout (p. 36)• verify (p. 36)• http_stats_receiver (facultatif) - Fonction à appeler avec un tableau associatif de statistiques de transfert

HTTP sur demande à l’aide du paramètre de configuration stats (p. 28).

Un gestionnaire DOIT pouvoir gérer l'option ou DOIT renvoyer une promesse rejetée, sauf si l'option estspécifiée comme étant facultative.

En plus des options @http spécifiques, un gestionnaire DOIT ajouter un en-tête User-Agent prenantla forme suivante, où « 3.X » peut être remplacé par Aws\Sdk::VERSION et « HandlerSpecificData/version ... » doit être remplacé par votre chaîne d'agent utilisateur spécifique au gestionnaire.

User-Agent: aws-sdk-php/3.X HandlerSpecificData/version ...

Flux du kit AWS SDK for PHP version 3Dans le cadre de son intégration du message HTTP standard PSR-7, le kit AWS SDK for PHP utilisePSR-7 StreamInterface en interne comme abstraction sur les flux PHP. Toute commande avec un champde saisie défini comme un blob, tel que le paramètre Body sur une commande S3::PutObject, peutêtre satisfaite avec une chaîne, une ressource de flux PHP ou une instance de Psr\Http\Message\StreamInterface.

Warning

Le kit SDK s'approprie n'importe quelle ressource de flux PHP brute fournie en tant que paramètred'entrée à une commande. Le flux est consommé et fermé en votre nom.Si vous avez besoin de partager un flux entre une opération SDK et votre code, encapsulez-ledans une instance GuzzleHttp\Psr7\Stream avant de l'inclure en tant que paramètre. Le kitSDK consomme le flux ; votre code a donc besoin de compter les mouvements du curseur internedu flux. Les flux Guzzle appellent fclose sur la ressource de flux sous-jacente lorsqu'ils sontdétruits par le nettoyage de mémoire de PHP. Par conséquent, vous n'avez pas besoin de fermerle flux vous-même.

Décorateurs de fluxGuzzle fournit plusieurs décorateurs de flux que vous pouvez utiliser pour contrôler la façon dont le kitSDK et Guzzle interagissent avec la ressource de streaming fournie en tant que paramètre d'entrée à unecommande. Ces décorateurs peuvent modifier la façon dont les gestionnaires sont en mesure de lire et derechercher sur un flux donné. Ce qui suit est une liste partielle ; vous trouverez plus d’informations sur leréférentiel GuzzleHttpPsr7.

AppendStreamGuzzleHttp\Psr7\AppendStream

Lectures à partir de plusieurs flux, l'un après l'autre.

use GuzzleHttp\Psr7;

$a = Psr7\stream_for('abc, ');$b = Psr7\stream_for('123.');

77

http://www.php-fig.org/psr/psr-7/

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Psr.Http.Message.StreamInterface.html

http://php.net/manual/en/intro.stream.php

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-s3-2006-03-01.html#putobject

https://github.com/guzzle/psr7

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.AppendStream.html

AWS SDK pour PHP Manuel du développeurDécorateurs de flux

$composed = new Psr7\AppendStream([$a, $b]);

$composed->addStream(Psr7\stream_for(' Above all listen to me'));

echo $composed(); // abc, 123. Above all listen to me.

CachingStreamGuzzleHttp\Psr7\CachingStream

Utilisé pour autoriser la recherche sur les octets précédemment lus ou sur les flux qui ne peuvent pas êtrerecherchés. Cela peut être utile lorsque le transfert d'un corps d'entité ne pouvant être recherché échoueen raison du besoin de revenir en arrière dans le flux (par exemple, suite à une redirection). Les donnéesqui sont lues à partir du flux distant sont mises en mémoire tampon dans un flux temporaire PHP afin demettre en cache les octets précédemment lus dans la mémoire, puis sur le disque.


$original = Psr7\stream_for(fopen('http://www.google.com', 'r'));$stream = new Psr7\CachingStream($original);

$stream->read(1024);echo $stream->tell();// 1024

$stream->seek(0);echo $stream->tell();// 0

InflateStreamGuzzleHttp\Psr7\InflateStream

Utilise le filtre PHP zlib.inflate pour gonfler ou dégonfler du contenu compressé avec gzip.

Ce décorateur de flux ignore les 10 premiers octets du flux donné pour supprimer l'en-tête gzip, convertitle flux fourni en ressource de flux PHP, et ajoute ensuite le filtre zlib.inflate. Le flux est ensuite converti enressource de flux Guzzle pour être utilisé comme flux Guzzle.

LazyOpenStreamGuzzleHttp\Psr7\LazyOpenStream

Lit ou écrit lentement dans un fichier qui est ouvert uniquement après qu'une opération d'I/O est effectuéedans le flux.


$stream = new Psr7\LazyOpenStream('/path/to/file', 'r');// The file has not yet been opened...

echo $stream->read(10);// The file is opened and read from only when needed.

LimitStreamGuzzleHttp\Psr7\LimitStream

78

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.CachingStream.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.InflateStream.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.LazyOpenStream.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.LimitStream.html

AWS SDK pour PHP Manuel du développeurDécorateurs de flux

Permet de lire un sous-ensemble ou une tranche d'un objet de flux existant. Cela peut être utile pour casserun fichier volumineux en parties plus petites pour être envoyées sous forme de fragments (par exemple,l'API de chargement partitionné Amazon S3).


$original = Psr7\stream_for(fopen('/tmp/test.txt', 'r+'));echo $original->getSize();// >>> 1048576

// Limit the size of the body to 1024 bytes and start reading from byte 2048$stream = new Psr7\LimitStream($original, 1024, 2048);echo $stream->getSize();// >>> 1024echo $stream->tell();// >>> 0

NoSeekStreamGuzzleHttp\Psr7\NoSeekStream

Encapsule un flux et n'autorise pas la recherche.


$original = Psr7\stream_for('foo');$noSeek = new Psr7\NoSeekStream($original);

echo $noSeek->read(3);// foovar_export($noSeek->isSeekable());// false$noSeek->seek(0);var_export($noSeek->read(3));// NULL

PumpStreamGuzzleHttp\Psr7\PumpStream

Fournit un flux en lecture seule qui pompe des données depuis une fonction PHP callable.

Lorsque vous appelez la fonction callable fournie, PumpStream passe le volume de données demandépour lire le callable. Le callable peut choisir de ne pas tenir compte de cette valeur et de renvoyer plus oumoins d'octets que demandé. Toute donnée supplémentaire renvoyée par le callable fourni est mise enmémoire tampon en interne jusqu'à être drainée à l'aide de la fonction read() de PumpStream. Le callablefourni DOIT renvoyer faux lorsqu'il n'y a pas d'autres données à lire.

Implémentation des décorateurs de fluxCréer un flux décorateur est très facile grâce à GuzzleHttp\Psr7\StreamDecoratorTrait. Cettecaractéristique fournit des méthodes qui implémentent Psr\Http\Message\StreamInterface enredirigeant vers un flux sous-jacent. use simplement le StreamDecoratorTrait et implémentez vosméthodes personnalisées.

Par exemple, supposons que nous voulions appeler une fonction particulière chaque fois que le dernieroctet d'un flux est lu. Ceci peut être implémenté en remplaçant la méthode read().

use Psr\Http\Message\StreamInterface;

79

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.NoSeekStream.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.PumpStream.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-GuzzleHttp.Psr7.StreamDecoratorTrait.html

AWS SDK pour PHP Manuel du développeurPaginateurs

use GuzzleHttp\Psr7\StreamDecoratorTrait;

class EofCallbackStream implements StreamInterface{ use StreamDecoratorTrait;

private $callback;

public function __construct(StreamInterface $stream, callable $cb) { $this->stream = $stream; $this->callback = $cb; }

public function read($length) { $result = $this->stream->read($length);

// Invoke the callback when EOF is hit if ($this->eof()) { call_user_func($this->callback); }

return $result; }}

Ce décorateur pourrait être ajouté à n'importe quel flux existant et utilisé comme ceci.


$original = Psr7\stream_for('foo');

$eofStream = new EofCallbackStream($original, function () { echo 'EOF!';});

$eofStream->read(2);$eofStream->read(1);// echoes "EOF!"$eofStream->seek(0);$eofStream->read(3);// echoes "EOF!"

Programmes de pagination du kit AWS SDK forPHP version 3

Certaines opérations de service AWS sont paginées et répondent avec des résultats tronqués. Parexemple, l’opération d’Amazon S3ListObjects ne peut renvoyer que jusqu’à 1 000 objets à la fois. Cesopérations (qui comportent généralement le préfixe « list » ou « describe ») requièrent l'exécution desdemandes suivantes avec des paramètres jeton (ou marqueur) afin de récupérer l'ensemble des résultats.

Les programmes de pagination sont une fonction du kit AWS SDK for PHP et jouent un rôle d’abstractionsur ce processus pour faciliter l’utilisation des API paginées pour les développeurs. Un programme depagination est principalement un itérateur de résultats. Ils est créé grâce à la méthode getPaginator()du client. Lorsque vous appelez getPaginator(), vous devez fournir le nom de l'opération et sesarguments (comme lors de l'exécution d'une opération). Vous pouvez itérer sur un objet de programme depagination en utilisant foreach pour obtenir les objets Aws\Result individuels.

80

AWS SDK pour PHP Manuel du développeurObjets de programme de pagination

$results = $s3Client->getPaginator('ListObjects', [ 'Bucket' => 'my-bucket']);

foreach ($results as $result) { foreach ($result['Contents'] as $object) { echo $object['Key'] . "\n"; }}

Objets de programme de paginationL'objet renvoyé par cette méthode getPaginator() est une instance de la classe Aws\ResultPaginator. Cette classe met en œuvre une interface native PHP iterator ; c'est pourquoielle fonctionne avec foreach. Il peut également être utilisé avec des fonctions d’itérateur, commeiterator_to_array, et s’intègre parfaitement avec les itérateurs SPL comme l’objet LimitIterator.

Les objets de programme de pagination ne peuvent contenir qu'une seule « page » de résultats à la fois etsont exécutés lentement. Ceci signifie qu'ils réalisent uniquement les demandes dont ils ont besoin pourobtenir la page de résultats. Par exemple, l’opération Amazon S3ListObjects ne peut renvoyer quejusqu’à 1 000 objets à la fois. Par conséquent, si le compartiment possède ~ 10 000 objets, le programmede pagination aura besoin de 10 requêtes au total. Lorsque vous parcourez les résultats, la premièredemande est exécutée lorsque vous démarrez l'itération, la deuxième lors de la deuxième itération de laboucle, et ainsi de suite.

Énumération de données à partir des résultatsLes objets de programme de pagination possèdent une méthode appelée search(), ce qui vous permetde créer des itérateurs pour les données dans un ensemble de résultats. Lorsque vous appelez search(),fournissez une expression JMESPath (p. 85) pour spécifier les données à extraire. Appeler search()renvoie un itérateur qui génère les résultats de l'expression sur chaque page de résultats. Ceci est évaluélentement, à mesure que vous parcourez l'itérateur renvoyé.

L'exemple suivant est équivalent à l'exemple de code précédent, mais utilise la méthodeResultPaginator::search() pour être plus concis.


foreach ($results->search('Contents[].Key') as $key) { echo $key . "\n";}

Les expressions JMESPath vous permettent de réaliser des opérations assez complexes. Par exemple,si vous souhaitez imprimer toutes les clés d'objet et les préfixes communs (par ex., faire un ls d'uncompartiment), vous pouvez effectuer les opérations suivantes.

// List all prefixes ("directories") and objects ("files") in the bucket$results = $s3Client->getPaginator('ListObjects', [ 'Bucket' => 'my-bucket', 'Delimiter' => '/']);

$expression = '[CommonPrefixes[].Prefix, Contents[].Key][]';foreach ($results->search($expression) as $item) { echo $item . "\n";

81

http://www.php.net/manual/en/spl.iterators.php

AWS SDK pour PHP Manuel du développeurPagination asynchrone

}

Pagination asynchroneVous pouvez itérer sur les résultats d'une programme de pagination de manière asynchrone en fournissantun rappel pour la méthode each() d'une Aws\ResultPaginator. La méthode de rappel est appeléepour chaque valeur générée par le programme de pagination.


$promise = $results->each(function ($result) { echo 'Got ' . var_export($result, true) . "\n";});

Note

L'utilisation de la méthode each() vous permet de paginer sur les résultats d'une opération d'APItout en envoyant d'autres demandes de manière asynchrone.

Une valeur de retour non nulle provenant du rappel sera générée par la promesse basée sur la coroutinesous-jacente. Cela signifie que vous pouvez renvoyer les promesses provenant du rappel qui doivent êtrerésolues avant de continuer l'itération sur les éléments restants, en fusionnant principalement d'autrespromesses à l'itération. La dernière valeur non nulle renvoyée par le rappel est le résultat qui répond à lapromesse de toutes les promesses en aval. Si la dernière valeur renvoyée est une promesse, la résolutionde cette promesse est le résultat qui répond ou rejette les promesses en aval.

// Delete all keys that end with "Foo"$promise = $results->each(function ($result) use ($s3Client) { if (substr($result['Key'], -3) ### 'Foo') { // Merge this promise into the iterator return $s3Client->deleteAsync([ 'Bucket' => 'my-bucket', 'Key' => 'Foo' ]); }});

$promise ->then(function ($result) { // Result would be the last result to the deleteAsync operation }) ->otherwise(function ($reason) { // Reason would be an exception that was encountered either in the // call to deleteAsync or calls performed while iterating });

// Forcing a synchronous wait will also wait on all of the deleteAsync calls$promise->wait();

Programmes d’attente du kit AWS SDK for PHPversion 3

Les programmes d’attente facilitent les opérations avec les systèmes basés sur la cohérence à terme.Ils offrent une méthode abstraite qui permet de patienter jusqu’à ce qu’une ressource entre dans un état

82

AWS SDK pour PHP Manuel du développeurConfiguration du programme d'attente

particulier en interrogeant la ressource. Pour connaître les programmes d'attente pris en charge par unclient, consultez la documentation sur l'API du client de service.

Dans l'exemple suivant, le client Amazon S3 est utilisé pour créer un compartiment. Le serveur est ensuiteutilisé pour patienter jusqu'à ce que le compartiment existe.

// Create a bucket$s3Client->createBucket(['Bucket' => 'my-bucket']);

// Wait until the created bucket is available$s3Client->waitUntil('BucketExists', ['Bucket' => 'my-bucket']);

Si le programme d'attente dépasse un certain nombre d'interrogations du compartiment, il lève uneexception \RuntimeException.

Configuration du programme d'attenteLes programmes d'attente sont gérés par un tableau associatif d'options de configuration. Toutes lesoptions utilisées par un programme d'attente spécifique possèdent des valeurs par défaut. Ces valeurspeuvent toutefois être remplacées pour prendre en charge d'autres stratégies d'attente.

Vous pouvez modifier les options de configuration du programme d'attente en transmettant un tableauassociatif d'options @waiter à l'argument $args des méthodes waitUntil() et getWaiter() d'unclient.

// Providing custom waiter configuration options to a waiter$s3Client->waitUntil('BucketExists', [ 'Bucket' => 'my-bucket', '@waiter' => [ 'delay' => 3, 'maxAttempts' => 10 ]]);

delay (int)

Durée d'attente entre deux tentatives d'interrogation (en secondes). Chaque programme d'attentepossède une valeur de configuration delay par défaut, que vous devrez peut-être modifier selon voscas d'utilisation spécifiques.

maxAttempts (int)

Nombre maximal de tentatives d'interrogation à émettre avant l'échec du programme d'attente. Cetteoption vous permet de ne pas attendre une ressource indéfiniment. Chaque programme d'attentepossède une valeur de configuration maxAttempts par défaut, que vous devrez peut-être modifierselon vos cas d'utilisation spécifiques.

initDelay (int)

Durée d'attente avant la première tentative d'interrogation (en secondes). Cette valeur peut s'avérerutile si vous savez que la ressource que vous attendez mettra un certain temps à atteindre l'étatsouhaité.

before (callable)

Fonction PHP de type callable appelée avant chaque tentative. La fonction est appelée à l'aide de lacommande Aws\CommandInterface sur le point d'être exécutée, selon le nombre de tentatives quiont déjà été exécutées. La fonction de type callable before permet de modifier des commandes avantleur exécution ou de fournir des informations d'avancement.

use Aws\CommandInterface;

83

AWS SDK pour PHP Manuel du développeurAttente asynchrone

$s3Client->waitUntil('BucketExists', [ 'Bucket' => 'my-bucket', '@waiter' => [ 'before' => function (CommandInterface $command, $attempts) { printf( "About to send %s. Attempt %d\n", $command->getName(), $attempts ); } ]]);

Attente asynchroneEn plus de l'attente synchrone, vous pouvez demander à un programme d'attente d'effectuer une attenteasynchrone lors de l'envoi d'autres requêtes ou en cas d'attente de plusieurs ressources en même temps.

Vous pouvez accéder à une promesse de programme d'attente en récupérant un programme d'attente àpartir d'un client à l'aide de la méthode getWaiter($name, array $args = []) du client. Utilisez laméthode promise() d'un programme d'attente pour démarrer ce dernier. Une promesse de programmed'attente est exécutée avec la dernière occurrence de Aws\CommandInterface exécutée dans leprogramme d'attente, ou rejetée avec RuntimeException en cas d'erreur.


$waiterName = 'BucketExists';$waiterOptions = ['Bucket' => 'my-bucket'];

// Create a waiter promise$waiter = $s3Client->getWaiter($waiterName, $waiterOptions);

// Initiate the waiter and retrieve a promise$promise = $waiter->promise();

// Call methods when the promise is resolved.$promise ->then(function () { echo "Waiter completed\n"; }) ->otherwise(function (\Exception $e) { echo "Waiter failed: " . $e . "\n"; });

// Block until the waiter completes or fails. Note that this might throw// a \RuntimeException if the waiter fails.$promise->wait();

L'exposition d'une API de programme d'attente basée sur des promesses permet de mettre en œuvredes cas d'utilisation puissants avec une surcharge relativement faible. Imaginons par exemple que voussouhaitiez attendre plusieurs ressources et agir avec le premier programme d'attente résolu avec succès.


// Create an array of waiter promises$promises = [ $s3Client->getWaiter('BucketExists', ['Bucket' => 'a'])->promise(), $s3Client->getWaiter('BucketExists', ['Bucket' => 'b'])->promise(), $s3Client->getWaiter('BucketExists', ['Bucket' => 'c'])->promise()

84

AWS SDK pour PHP Manuel du développeurExpressions JMESPath

];

// Initiate a race between the waiters, fulfilling the promise with the// first waiter to complete (or the first bucket to become available)$any = Promise\any($promises) ->then(function (CommandInterface $command) { // This is invoked with the command that succeeded in polling the // resource. Here we can know which bucket won the race. echo "The {$command['Bucket']} waiter completed first!\n"; });

// Force the promise to complete$any->wait();

Expressions JMESPath dans le kit AWS SDK forPHP version 3

JMESPath vous permet de spécifier par déclaration comment extraire des éléments d’un document JSON.Le kit AWS SDK for PHP dispose d’une dépendance sur jmespath.php afin d’alimenter certaines desabstractions de haut niveau telles que les programmes de pagination dans le kit AWS SDK pour PHPversion 3 (p. 80) et les programmes d’attente dans le kit AWS SDK pour PHP version 3 (p. 82). Ilexpose également la recherche JMESPath sur Aws\ResultInterface et Aws\ResultPaginator.

Vous pouvez commencer à utiliser JMESPath dans votre navigateur en essayant les exemples JMESPathen ligne. Pour en savoir plus sur la langue, y compris les expressions et fonctions disponibles, consultez laspécification JMESPath.

L’AWS CLI prend en charge JMESPath. Les expressions écrites pour la sortie CLI sont entièrementcompatibles avec les expressions écrites pour le kit AWS SDK for PHP.

Extraire des données à partir de résultatsL'interface Aws\ResultInterface dispose d'une méthode search($expression) permettantd'extraire des données à partir d'un modèle de résultat basé sur une expression JMESPath. Utiliser desexpressions JMESPath pour interroger les données d'un objet de résultat peut vous aider à supprimer lecode conditionnel réutilisable et à exprimer de manière plus concise les données extraites.

Pour illustrer son fonctionnement, nous commencerons avec la sortie JSON par défaut ci-dessous, quidécrit deux volumes Amazon Elastic Block Store (Amazon EBS) attachés à des instances Amazon EC2distinctes.

$result = $ec2Client->describeVolumes();// Output the result data as JSON (just so we can clearly visualize it)echo json_encode($result->toArray(), JSON_PRETTY_PRINT);

{ "Volumes": [ { "AvailabilityZone": "us-west-2a", "Attachments": [ { "AttachTime": "2013-09-17T00:55:03.000Z", "InstanceId": "i-a071c394", "VolumeId": "vol-e11a5288", "State": "attached", "DeleteOnTermination": true,

85


https://github.com/jmespath/jmespath.php

http://jmespath.org/examples.html

http://jmespath.org/specification.html

https://aws.amazon.com/cli/

AWS SDK pour PHP Manuel du développeurExtraire des données à partir de résultats

"Device": "/dev/sda1" } ], "VolumeType": "standard", "VolumeId": "vol-e11a5288", "State": "in-use", "SnapshotId": "snap-f23ec1c8", "CreateTime": "2013-09-17T00:55:03.000Z", "Size": 30 }, { "AvailabilityZone": "us-west-2a", "Attachments": [ { "AttachTime": "2013-09-18T20:26:16.000Z", "InstanceId": "i-4b41a37c", "VolumeId": "vol-2e410a47", "State": "attached", "DeleteOnTermination": true, "Device": "/dev/sda1" } ], "VolumeType": "standard", "VolumeId": "vol-2e410a47", "State": "in-use", "SnapshotId": "snap-708e8348", "CreateTime": "2013-09-18T20:26:15.000Z", "Size": 8 } ], "@metadata": { "statusCode": 200, "effectiveUri": "https:\/\/ec2.us-west-2.amazonaws.com", "headers": { "content-type": "text\/xml;charset=UTF-8", "transfer-encoding": "chunked", "vary": "Accept-Encoding", "date": "Wed, 06 May 2015 18:01:14 GMT", "server": "AmazonEC2" } }}

Tout d'abord, nous pouvons récupérer uniquement le premier volume de la liste Volumes à l'aide de lacommande suivante.

$firstVolume = $result->search('Volumes[0]');

Nous allons maintenant utiliser l'expression wildcard-index [*] pour parcourir l'ensemble de la liste,extraire, puis renommer trois éléments : VolumeId est renommé ID, AvailabilityZone est renomméAZ et Size reste Size. Nous pouvons extraire et renommer ces éléments à l'aide d'une expressionmulti-hash placée après l'expression wildcard-index.

$data = $result->search('Volumes[*].{ID: VolumeId, AZ: AvailabilityZone, Size: Size}');

Nous obtenons ainsi un tableau de données PHP comme suit :

array(2) { [0] => array(3) { 'AZ' => string(10) "us-west-2a"

86

AWS SDK pour PHP Manuel du développeurExtraire des données à partir de résultats

'ID' => string(12) "vol-e11a5288" 'Size' => int(30) } [1] => array(3) { 'AZ' => string(10) "us-west-2a" 'ID' => string(12) "vol-2e410a47" 'Size' => int(8) }}

Dans la notation multi-hash, vous pouvez également utiliser des clés de chaînes commekey1.key2[0].key3 pour extraire des éléments profondément imbriqués au sein de la structure.L'exemple suivant illustre ce processus avec la clé Attachments[0].InstanceId, dont l'alias estsimplement InstanceId. (Dans la plupart des cas, les expressions JMESPath ignoreront les espaces.)

$expr = 'Volumes[*].{ID: VolumeId, InstanceId: Attachments[0].InstanceId, AZ: AvailabilityZone, Size: Size}';

$data = $result->search($expr);var_dump($data);

L'expression précédente générera les données suivantes :

array(2) { [0] => array(4) { 'ID' => string(12) "vol-e11a5288" 'InstanceId' => string(10) "i-a071c394" 'AZ' => string(10) "us-west-2a" 'Size' => int(30) } [1] => array(4) { 'ID' => string(12) "vol-2e410a47" 'InstanceId' => string(10) "i-4b41a37c" 'AZ' => string(10) "us-west-2a" 'Size' => int(8) }}

Vous pouvez également filtrer plusieurs éléments avec l'expression multi-list :[key1, key2]. Cetteopération met en forme tous les attributs filtrés dans une seule liste ordonnée par objet, quel que soit letype.

$expr = 'Volumes[*].[VolumeId, Attachments[0].InstanceId, AvailabilityZone, Size]';

87

AWS SDK pour PHP Manuel du développeurExtraire des données à partir de programmes de pagination

$data = $result->search($expr);var_dump($data);

Exécuter la recherche précédente génère les données suivantes :

array(2) { [0] => array(4) { [0] => string(12) "vol-e11a5288" [1] => string(10) "i-a071c394" [2] => string(10) "us-west-2a" [3] => int(30) } [1] => array(4) { [0] => string(12) "vol-2e410a47" [1] => string(10) "i-4b41a37c" [2] => string(10) "us-west-2a" [3] => int(8) }}

Utilisez une expression filter pour filtrer les résultats sur la valeur d'un champ spécifique. L'exemple derequête suivant produit en sortie uniquement des volumes dans la zone de disponibilité us-west-2a.

$data = $result->search("Volumes[?AvailabilityZone ## 'us-west-2a']");

JMESPath prend également en charge les expressions de fonction. Supposons que vous souhaitiezexécuter la même requête que ci-dessus, mais en récupérant tous les volumes dans lesquels le volumese trouve dans une région AWS commençant par « us- ». L'expression suivante utilise la fonctionstarts_with, transmettant un littéral de chaîne de us-. Le résultat de cette fonction est ensuite comparéà la valeur JSON littérale de true, transmettant uniquement les résultats du prédicat de filtre ayantrenvoyés true via la projection de filtre.

$data = $result->search('Volumes[?starts_with(AvailabilityZone, 'us-') ## `true`]');

Extraire des données à partir de programmes depaginationComme vous l’avez appris dans le guide Programmes de pagination dans le kit AWS SDK pour PHPversion 3 (p. 80), les objets Aws\ResultPaginator sont utilisés pour générer des résultats à partird’une opération d’API paginable. Le kit AWS SDK for PHP vous permet d’extraire et de parcourir desdonnées filtrées à partir d’objets Aws\ResultPaginator, implémentant essentiellement une flat-map surl’itérateur dans lequel le résultat d’une expression JMESPath est la fonction map.

Supposons que vous souhaitiez créer un iterator générant uniquement des objets de taille supérieure à1 Mo à partir d'un compartiment. Cette opération peut être réalisée en créant un programme de paginationListObjects, puis en appliquant une fonction search() au programme de pagination et en créant unitérateur « flat-mappé » sur les données paginées.

88

http://martinfowler.com/articles/collection-pipeline/flat-map.html

AWS SDK pour PHP Manuel du développeurSDK Metrics

$result = $s3Client->getPaginator('ListObjects', ['Bucket' => 't1234']);$filtered = $result->search('Contents[?Size > `1048576`]');

// The result yielded as $data will be each individual match from// Contents in which the Size attribute is > 1048576foreach ($filtered as $data) { var_dump($data);}

Métriques SDK dans le kit AWS SDK for PHPversion 3

Les clients professionnels peuvent utiliser Kit AWS SDK Metrics for Enterprise Support avec PHP(Métriques SDK) pour collecter des métriques à partir des kits AWS SDK sur leurs hôtes et clients partagésavec AWS Enterprise Support. SDK Metrics fournit des informations qui aident à accélérer la détection et lediagnostic de problèmes survenant dans les connexions aux services AWS pour les clients AWS EnterpriseSupport.

La télémétrie étant collectée sur chaque hôte, elle est relayée via UDP vers l'hôte local, où l'agentCloudWatch regroupe les données et les envoie au service Métriques SDK. Par conséquent, pour recevoirdes métriques, vous devez ajouter l'agent CloudWatch à votre instance.

Pour en savoir plus sur SDK Metrics, consultez le Amazon CloudWatch User Guide.

Chacune des rubriques suivantes décrit comment configurer et gérer Métriques SDK pour le kit AWS SDKfor PHP.

Rubriques• Autoriser le kit Métriques SDK à collecter et à envoyer des métriques dans le kit AWS SDK for PHP

version 3 (p. 89)• Configurer Métriques SDK pour le kit AWS SDK for PHP version 3 (p. 92)• Définitions relatives à Métriques SDK (p. 96)

Autoriser le kit Métriques SDK à collecter et à envoyerdes métriques dans le kit AWS SDK for PHP version 3Pour collecter des métriques à partir des kits AWS SDK en utilisant Kit AWS SDK Metrics for EnterpriseSupport avec PHP, les clients professionnels doivent créer un rôle IAM autorisant l'agent CloudWatch àcollecter des données provenant de son environnement de production ou de son instance Amazon EC2.

Utilisez l'exemple de code PHP suivant ou la console AWS pour créer une stratégie et un rôle IAM pour unagent CloudWatch afin qu'il puisse accéder à Métriques SDK dans votre environnement.

Pour en savoir plus sur l'utilisation de Métriques SDK avec AWS SDK for PHP, consultez Configurer SDKMetrics pour le kit AWS SDK pour PHP version 3 (p. 92). Pour plus d'informations sur Métriques SDK,consultez la section Autorisations IAM pour SDK Metrics du Amazon CloudWatch User Guide.

Configurer les autorisations d'accès à l'aide du AWS SDK forPHPCréez un rôle IAM pour l'instance disposant d'une autorisation pour Amazon EC2 Systems Manager etMétriques SDK.

89

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-SDK-Metrics.html

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Set-IAM-Permissions-For-SDK-Metrics.html

AWS SDK pour PHP Manuel du développeurAutoriser les métriques du kit SDK

Tout d'abord, créez une stratégie à l'aide de CreatePolicy. Ensuite, créez un rôle à l'aide de CreateRole.Enfin, attachez la stratégie que vous avez créée à votre nouveau rôle avec AttachRolePolicy.

Importations


use Aws\Iam\IamClient; use Aws\Exception\AwsException;

Exemple de code

$client = new IamClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2010-05-08']);

$roleName = 'AmazonCSM';

$description = 'An Instance role that has permission for Amazon EC2 Systems Manager and SDK Metric Monitoring.';

$AmazonCSMPolicy = '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sdkmetrics-beta:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "ssm:GetParameter" ], "Resource": "arn:aws:ssm:*:*:parameter/AmazonCSM*" } ] }';

$rolePolicy = '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ]}';

try { $iamPolicy = $client->createPolicy([ 'PolicyName' => $roleName . 'policy', 'PolicyDocument' => $AmazonCSMPolicy ]); if ($iamPolicy['@metadata']['statusCode'] == 200) {

90

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createpolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createrole

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachrolepolicy

AWS SDK pour PHP Manuel du développeurAutoriser les métriques du kit SDK

$policyArn = $iamPolicy['Policy']['Arn']; echo('<p> Your IAM Policy has been created. Arn - '); echo($policyArn); echo('<p>'); $role = $client->createRole([ 'RoleName' => $roleName, 'Description' => $description, 'AssumeRolePolicyDocument' => $rolePolicy, ]); echo('<p> Your IAM User Role has been created. Arn: '); echo($role['Role']['Arn']); echo('<p>'); if ($role['@metadata']['statusCode'] == 200) { $result = $client->attachRolePolicy([ 'PolicyArn' => $policyArn, 'RoleName' => $roleName, ]); var_dump($result) } else { echo('<p> There was an error creating your IAM User Role </p>'); var_dump($role); } } else { echo('<p> There was an error creating your IAM Policy </p>'); var_dump($iamPolicy); }} catch (AwsException $e) { // output error message if fails echo $e; error_log($e->getMessage()); }

Configurer les autorisations d'accès en utilisant la console IAMVous pouvez aussi utiliser la console IAM pour créer un rôle.

1. Accédez à la console IAM et créez un rôle pour utiliser Amazon EC2.2. Dans le panneau de navigation, choisissez Roles (Rôles).3. Choisissez Create Role (Créer un rôle).4. Choisissez AWS Service, puis EC2.5. Choisissez Next: Permissions (Suivant : Autorisations).6. Sous Attach permissions policies (Attacher une stratégie d'autorisations), choisissez create policy (créer

une stratégie).7. Pour Service, choisissez Systems Manager (Gestionnaire de systèmes). Pour Actions, développez

Read, puis choisissez GetParameters. Pour les ressources, spécifiez votre agent CloudWatch.8. Ajoutez une autorisation supplémentaire.9. Sélectionnez Choose a service (Choisir un service), puis Enter service manually (Entrer un service

manuellement). Pour Service, entrez sdkmetrics. Sélectionnez toutes les actions et toutes lesressources sdkmetrics, puis choisissez Review Policy (Vérifier la stratégie).

10.Donnez un nom au Rôle AmazonSDKMetrics, puis ajoutez une description.11.Choisissez Create Role (Créer un rôle).

91

https://console.aws.amazon.com/iam

AWS SDK pour PHP Manuel du développeurConfigurer les métriques du kit SDK

Configurer Métriques SDK pour le kit AWS SDK forPHP version 3Les étapes suivantes montrent comment configurer Métriques SDK pour le kit AWS SDK for PHP. Cesétapes appartiennent à une instance Amazon EC2 exécutant Amazon Linux pour une application clientequi utilise le kit AWS SDK for PHP. Métriques SDK est également disponible pour vos environnements deproduction si vous l'activez pendant la configuration du kit AWS SDK for PHP.

Pour utiliser Métriques SDK, exécutez la version la plus récente de l'agent CloudWatch. Découvrezcomment configurer l'agent CloudWatch pour SDK Metrics dans le Amazon CloudWatch User Guide.

Pour plus d'informations sur les autorisations IAM pour Métriques SDK, consultez l'article Autorisations IAMpour SDK Metrics pour le kit AWS SDK pour PHP (p. 89).

Pour configurer Métriques SDK avec le kit AWS SDK for PHP, procédez comme suit :

1. Créez une application avec un client AWS SDK for PHP pour utiliser un service AWS.2. Hébergez votre projet sur une instance Amazon EC2 ou dans votre environnement local.3. Installez et utilisez la version la plus récente du kit AWS SDK for PHP.4. Installez et configurez un agent CloudWatch sur une instance EC2 ou dans votre environnement local.5. Autorisez Métriques SDK à collecter et envoyer des métriques.6. Activez SDK Metrics pour le kit AWS SDK pour PHP (p. 92).

Pour de plus amples informations, consultez les ressources suivantes :

• Mettre à jour un agent CloudWatch (p. 94)• Désactiver SDK Metrics (p. 95)

Activer Métriques SDK pour le kit AWS SDK for PHPPar défaut, Métriques SDK est désactivé, l'hôte est défini sur « 127.0.0.1 » et le port est défini sur 31000.Les paramètres par défaut sont les suivants.

//default values [ 'enabled' => false, 'host' => '127.0.0.1', 'port' => 31000, ]

L'activation de Métriques SDK est indépendante de la configuration de vos informations d'identification pourl'utilisation d'un service AWS.

Vous pouvez activer Métriques SDK en transmettant une option de configuration du client, en définissantdes variables d'environnement ou en utilisant le fichier de configuration partagée AWS.

Ordre de priorité

L'ordre de priorité est le suivant (1 remplace 2-3, etc.) :

1. Option de configuration du client2. Variables d'environnement3. Fichier de configuration partagée AWS

92

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Configure-CloudWatch-Agent-SDK-Metrics.html


Option 1 : Option de configuration du clientVous pouvez transmettre une option csm à votre constructeur client pour activer et définir lesoptions de configuration. Cette option peut être un tableau associatif, une instance de \Aws\ClientSideMonitoring\ConfigurationInterface, un élément joignable qui fournit une instancede \Aws\ClientSideMonitoring\ConfigurationInterface ou la valeur booléenne de false.

Tableaux associatifs :

$client = new \Aws\S3\S3Client([ 'region' => 'your-region', 'version' => 'latest', 'csm' => [ 'enabled' => true, 'host' => 'my.host', 'port' => 1234, 'client_id' => 'My Application' ]]);

Instance de \Aws\ClientSideMonitoring\ConfigurationInterface :

$client = new \Aws\S3\S3Client([ 'region' => 'your-region', 'version' => 'latest', 'csm' => new \Aws\ClientSideMonitoring\Configuration( true, 'my.host', 1234, 'My Application' )]);

Élément joignable :

$client = new \Aws\S3\S3Client([ 'region' => 'your-region', 'version' => 'latest', 'csm' => function() { return new \Aws\ClientSideMonitoring\Configuration( true, '127.0.0.1', 1234, 'My Application' ); }]);

Valeur booléenne « false » :

$client = new \Aws\S3\S3Client([ 'region' => 'your-region', 'version' => 'latest', 'csm' => false]);

Option 2 : Définir des variables d'environnementLe kit SDK vérifie d'abord le profil spécifié dans la variable d'environnement sous AWS_PROFILE afin dedéterminer si Métriques SDK est activé.

93


Pour activer Métriques SDK, ajoutez les éléments suivants à vos variables d'environnement.

export AWS_CSM_ENABLED=true

D'autres paramètres de configuration (p. 94) sont disponibles. Pour plus d'informations surl'utilisation de fichiers partagés, consultez Utilisation d'informations d'identification à partir de variablesd'environnement (p. 44).

Note

L'activation de Métriques SDK ne configure pas vos informations d'identification pour utiliser unservice AWS. Pour ce faire, consultez Informations d'identification pour le kit AWS SDK pour PHPversion 3 (p. 42).

Option 3 : Fichier de configuration partagée AWSSi aucune configuration CSM n'est trouvée dans les variables d'environnement, le kit SDK recherche votrechamp de profil AWS par défaut. Si AWS_DEFAULT_PROFILE est défini sur une valeur autre que celle pardéfaut, mettez à jour ce profil. Pour activer SDK Metrics, ajoutez csm_enabled au fichier de configurationpartagée situé sous ~/.aws/config.

[default]csm_enabled = true

[profile aws_csm]csm_enabled = true

D'autres paramètres de configuration (p. 94) sont disponibles. Pour plus d'informations sur l'utilisationde fichiers partagés AWS, consultez Utilisation du fichier d'informations d'identification AWS et des profilsd'informations d'identification (p. 45).

Note

L'activation de Métriques SDK ne configure pas vos informations d'identification pour utiliser unservice AWS. Pour ce faire, consultez Informations d'identification pour le kit AWS SDK pour PHPversion 3 (p. 42).

Mettre à jour un agent CloudWatchPour modifier l'hôte ou l’ID de port, vous devez définir les valeurs, puis redémarrer toutes les tâches AWSactuellement actives.

Option 1 : Option de configuration du clientConsultez l'option 1 ci-dessus sous « Activer Métriques SDK pour le kit AWS SDK for PHP » pour accéderà des exemples de définition de l'option csm de configuration du client en vue de modifier les paramètresCSM.

Option 2 : Définir des variables d'environnementLa plupart des services AWS utilisent le port par défaut. Mais si le service qui doit être surveillépar Métriques SDK utilise un port unique, ajoutez AWS_CSM_PORT=[numéro_port] aux variablesd'environnement de l'hôte. De plus, un autre hôte peut être spécifié à l’aide de la variable d’environnementAWS_CSM_HOST.

export AWS_CSM_ENABLED=trueexport AWS_CSM_PORT=1234export AWS_CSM_HOST=192.168.0.1

94


Option 3 : Fichier de configuration partagée AWS

La plupart des services utilisent le port par défaut. Si votre service requiert un ID de port unique, ajoutezcsm_port=[numéro_port] dans ~/.aws/config. Un hôte autre que l’hôte par défaut peut être configuré aveccsm_host.

[default]csm_enabled = falsecsm_host = 123.4.5.6csm_port = 1234

[profile aws_csm]csm_enabled = falsecsm_host = 123.4.5.6csm_port = 1234

Redémarrer Métriques SDK

Pour redémarrer une tâche, exécutez les commandes suivantes.

amazon-cloudwatch-agent-ctl –a stop;amazon-cloudwatch-agent-ctl –a start;

Désactiver Métriques SDKPour désactiver Métriques SDK, configurez csm_enabled sur false dans vos variables d'environnement, oudans votre fichier de configuration partagée AWS situé sous ~/.aws/config. Ensuite, redémarrez votreagent CloudWatch pour que les modifications prennent effet.

Définir csm_enabled sur falseNote

Notez l'ordre de priorité répertorié ci-dessus. Par exemple, si Métriques SDK est activé dans lesvariables d'environnement, mais désactivé dans le fichier de configuration, Métriques SDK resteactivé.

Option 1 : configuration du client

$client = new \Aws\S3\S3Client([ 'region' => 'your-region', 'version' => 'latest', 'csm' => false]);

Option 2 : variables d’environnement

export AWS_CSM_ENABLED=false

Option 3 : Fichier de configuration partagée AWS

[default]csm_enabled = false

[profile aws_csm]csm_enabled = false

95

AWS SDK pour PHP Manuel du développeurDéfinitions de SDK Metrics

Arrêter Métriques SDK et redémarrer l'agent CloudWatchPour désactiver Métriques SDK, utilisez la commande suivante.

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a stop &&echo "Done"

Si vous utilisez d'autres fonctions CloudWatch, redémarrez CloudWatch avec la commande suivante.

amazon-cloudwatch-agent-ctl –a start;

Définitions relatives à Métriques SDKVous pouvez utiliser les descriptions suivantes de Métriques SDK pour interpréter vos résultats. Engénéral, ces métriques sont utilisées pour examiner le compte avec le gestionnaire technique de compteau cours de révisions d'évaluation régulières. Les ressources AWS Support et votre gestionnaire techniquede compte doivent avoir accès aux données de SDK Metrics pour vous aider à résoudre les incidents. Sivous découvrez des données ambiguës ou inattendues qui ne semblent pas impacter négativement lesperformances de vos applications, il est conseillé de les examiner au cours des révisions d'évaluation.

Métrique : CallCount

Définition Nombre total d'appels d'API ayant réussi ouéchoué effectués à partir de votre code vers lesservices AWS

Comment l'utiliser Utilisez-la comme base de référence pour établirune corrélation avec d'autres métriques comme leserreurs ou la limitation.

Métrique : ClientErrorCount

Définition Nombre d'appels d'API qui ont échoué avec deserreurs client (codes de réponse HTTP 4xx).Exemples : limitation, accès refusé, compartimentS3 inexistant ou valeur de paramètre non valide.

Comment l'utiliser Sauf dans certains cas liés à la limitation (parexemple, lorsque celle-ci se produit en raison d'unelimite qui doit être augmentée), cette métrique peutsignaler qu'un élément de votre application doit êtrecorrigé.

Métrique : ConnectionErrorCount

Définition Nombre d'appels d'API qui échouent en raisond'erreurs de connexion au service. Cela peut êtredû à des problèmes réseau entre l'application duclient et des services AWS, dont des équilibreursde charge, des échecs DNS et des fournisseursde transit. Dans certains cas, des problèmes AWSpeuvent provoquer cette erreur.

96

AWS SDK pour PHP Manuel du développeurDéfinitions de SDK Metrics

Métrique : ConnectionErrorCount

Comment l'utiliser Utilisez cette métrique pour déterminer si desproblèmes sont spécifiques à votre applicationou causés par l'infrastructure et/ou le réseau.Une valeur ConnectionErrorCount élevéepeut également indiquer des valeurs de délaid'expiration court pour les appels d'API.

Métrique : ThrottleCount

Définition Nombre d'appels d'API qui échouent en raison dela limitation par les services AWS.

Comment l'utiliser Utilisez cette métrique pour évaluer si votreapplication a atteint des limites, ainsi que pourdéterminer la cause des nouvelles tentatives et dela latence de l'application. Envisagez de distribuerles appels via une fenêtre plutôt que de les traiterpar lot.

Métrique : ServerErrorCount

Définition Nombre d'appels d'API qui échouent en raisond'erreurs de serveur (codes de réponse HTTP 5xx)à partir de services AWS. Ils sont généralementcausés par des services AWS.

Comment l'utiliser Déterminez la cause des nouvelles tentatives du kitSDK ou de la latence. Cette métrique n'indique pastoujours que les services AWS sont responsables,car certaines équipes AWS classent la latence entant que réponse HTTP 503.

Métrique : EndToEndLatency

Définition Durée totale nécessaire à votre application poureffectuer un appel à l'aide du kit AWS SDK,nouvelles tentatives comprises. En d'autres termes,le fait qu'un appel aboutisse après plusieurstentatives ou échoue en raison d'une erreurirrémédiable n'est pas pris en compte.

Comment l'utiliser Déterminez la façon dont les appels d'APIAWS contribuent à la latence globale de votreapplication. Une latence plus élevée que prévupeut être causée par des problèmes liés auréseau ou au pare-feu, à d'autres paramètres deconfiguration, ou par la latence qui résulte desnouvelles tentative du kit SDK.

97

AWS SDK pour PHP Manuel du développeurAWS Cloud9

Utilisation des services AWS avec lekit AWS SDK for PHP version 3

Certains services AWS pris en charge par le kit AWS SDK for PHP version 3 comprennent des fonctionssupplémentaires en plus de l’exécution d’opérations sur une API. Ce guide décrit ces fonctions de hautniveau par service.

Rubriques• Utilisation d’AWS Cloud9 avec le kit AWS SDK for PHP version 3 (p. 98)• Utilisation du gestionnaire de sessions DynamoDB avec le kit AWS SDK for PHP version 3 (p. 100)• Client sur plusieurs régions Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 105)• Encapsuleur de flux Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 106)• Gestionnaire de transferts Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 111)• Chiffrement côté client Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 114)

Utilisation d’AWS Cloud9 avec le kit AWS SDK forPHP version 3

Vous pouvez utiliser AWS Cloud9 avec le kit AWS SDK for PHP version 3 pour écrire, exécuter etdéboguer votre code PHP à l’aide d’un simple navigateur. AWS Cloud9 inclut des outils tels qu’un éditeurde code, un débogueur et un terminal. L'IDE AWS Cloud9 étant basé sur le cloud, vous pouvez travaillersur vos projets depuis votre bureau, votre domicile ou tout appareil connecté à Internet. Pour obtenir desinformations générales sur AWS Cloud9, consultez le Guide de l’utilisateur AWS Cloud9.

Suivez ces instructions pour configurer AWS Cloud9 avec le kit AWS SDK for PHP :

• Étape 1 : Configurer votre compte AWS pour utiliser AWS Cloud9 (p. 98)• Étape 2 : Configurer votre environnement de développement AWS Cloud9 (p. 99)• Étape 3 : Configurer le kit AWS SDK pour PHP (p. 99)• Étape 4 : Télécharger l’exemple de code (p. 99)• Étape 5 : Exécuter et déboguer l’exemple de code (p. 100)

Étape 1 : Configurer votre compte AWS pour utiliserAWS Cloud9Commencez à utiliser AWS Cloud9 en vous connectant à la console AWS Cloud9 en tant qu'entité AWSIdentity and Access Management (IAM) (par exemple, un utilisateur IAM) dans votre compte AWS doté desautorisations d'accès à AWS Cloud9.

Pour configurer une entité IAM dans votre compte AWS afin d’accéder à AWS Cloud9 et de vous connecterà la console AWS Cloud9, consultez la section Configuration d’équipe pour AWS Cloud9 du Guide del’utilisateur AWS Cloud9.

98

https://docs.aws.amazon.com/cloud9/latest/user-guide/

https://docs.aws.amazon.com/cloud9/latest/user-guide/setup.html



AWS SDK pour PHP Manuel du développeurÉtape 2 : Configurer votre environnement

de développement AWS Cloud9

Étape 2 : Configurer votre environnement dedéveloppement AWS Cloud9Une fois connecté à la console AWS Cloud9, utilisez la console pour créer un environnementde développement AWS Cloud9. Une fois l'environnement créé, AWS Cloud9 ouvre l'IDE de cetenvironnement.

Consultez la section Création d’un environnement dans AWS Cloud9 du Guide de l’utilisateur AWS Cloud9pour plus de détails.

Note

Si vous créez votre environnement dans la console pour la première fois, nous vousrecommandons de choisir l'option Create a new instance for environment (EC2) (Créer unenouvelle instance pour l'environnement (EC2)). Cette option indique à AWS Cloud9 de créer unenvironnement, de lancer une instance Amazon EC2, puis de connecter la nouvelle instance aunouvel environnement. C'est le moyen le plus rapide de commencer à utiliser AWS Cloud9.

Étape 3 : Configurer le kit AWS SDK for PHPUne fois l’IDE de votre environnement de développement ouvert par AWS Cloud9, utilisez l’IDE pourconfigurer le kit AWS SDK for PHP dans votre environnement, comme suit.

1. Si le terminal n'est pas déjà ouvert dans l'IDE, ouvrez-le. Choisissez Window, New Terminal (Fenêtre,Nouveau terminal) dans la barre de menus de l'IDE.

2. Exécutez les commandes suivantes pour installer le kit AWS SDK for PHP.

curl -sS https://getcomposer.org/installer | phpphp composer.phar require aws/aws-sdk-php

Si l'IDE ne parvient pas à trouver PHP, exécutez la commande suivante pour l'installer. (Cette commandesuppose que vous avez choisi l'option Create a new instance for environment (EC2) (Créer une nouvelleinstance pour l'environnement (EC2)) plus haut dans cette rubrique.)

sudo yum -y install php56

Étape 4 : Télécharger l’exemple de codeUtilisez le terminal que vous avez ouvert à l’étape précédente pour télécharger l’exemple de code pour lekit AWS SDK for PHP dans l’environnement de développement AWS Cloud9.

Pour ce faire, exécutez la commande suivante. Cette commande télécharge une copie de tous lesexemples de code utilisés dans la documentation du kit AWS SDK officielle vers le répertoire racine devotre environnement.

git clone https://github.com/awsdocs/aws-doc-sdk-examples.git

Pour trouver des exemples de code pour le kit AWS SDK for PHP, utilisez la fenêtre Environnementpour ouvrir le répertoire ENVIRONMENT_NAMEaws-doc-sdk-examplesphpexample_code, oùENVIRONMENT_NAME est le nom de votre environnement de développement.

Pour apprendre à utiliser ces exemples et d’autres exemples de code, consultez la section Exemples decode (p. 119).

99

https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html


AWS SDK pour PHP Manuel du développeurÉtape 5 : Exécuter et déboguer l’exemple de code

Étape 5 : Exécuter et déboguer l’exemple de codePour exécuter le code dans votre environnement de développement AWS Cloud9, consultez la sectionExécuter votre code du Guide de l’utilisateur AWS Cloud9.

Pour déboguer le code, consultez la section Déboguer votre code du Guide de l’utilisateur AWS Cloud9.

Utilisation du gestionnaire de sessions DynamoDBavec le kit AWS SDK for PHP version 3

Le gestionnaire de sessions DynamoDB est un gestionnaire de sessions personnalisé pour PHP, quipermet aux développeurs d’utiliser Amazon DynamoDB en tant que magasin de session. L’utilisation deDynamoDB pour la session de stockage résout les problèmes de gestion de session dans une applicationWeb distribuée en déplaçant les sessions hors du système de fichiers local vers un emplacementpartagé. DynamoDB est rapide et évolutif, facile à configurer et gère la réplication de vos donnéesautomatiquement.

Le gestionnaire de sessions DynamoDB utilise la fonction session_set_save_handler() pourraccorder les opérations DynamoDB dans les fonctions de session natives de PHP pour permettre unvéritable remplacement. Cela inclut la prise en charge de fonctions telles que le verrouillage de session etle nettoyage de la mémoire, qui font partie intégrante du gestionnaire de sessions par défaut de PHP.

Pour plus d’informations sur le service DynamoDB, consultez la page d’accueil Amazon DynamoDB.

Utilisation de baseÉtape 1 : Enregistrer le GestionnaireTout d'abord, instanciez et enregistrez le gestionnaire de sessions.

use Aws\DynamoDb\SessionHandler;

$sessionHandler = SessionHandler::fromClient($dynamoDb, [ 'table_name' => 'sessions']);

$sessionHandler->register();

100

https://docs.aws.amazon.com/cloud9/latest/user-guide/build-run-debug.html


https://docs.aws.amazon.com/cloud9/latest/user-guide/build-run-debug.html


http://www.php.net/manual/en/ref.session.php

https://aws.amazon.com/dynamodb/

AWS SDK pour PHP Manuel du développeurConfiguration

Étape 2. Créer un tableau pour stocker vos sessionsAvant de pouvoir utiliser le gestionnaire de session, vous devez créer un tableau dans lequel stocker lessessions. Vous pouvez le faire à l'avance à l'aide de la console AWS pour Amazon DynamoDB ou enutilisant le kit AWS SDK for PHP.

Lorsque vous créez ce tableau, utilisez « id » pour le nom de la clé primaire. Nous vous recommandonségalement de configurer un attribut de durée de vie en utilisant l'attribut « expires » pour bénéficier dunettoyage automatique de la mémoire des sessions.

Étape 3. Utiliser les sessions PHP comme vous le ferieznormalementUne fois que le gestionnaire de session est enregistré et que le tableau existe, vous pouvez écrire et liredepuis la session à l'aide de la variable superglobale $_SESSION, tout comme vous le feriez normalementavec le gestionnaire de sessions par défaut de PHP. Le gestionnaire de sessions DynamoDB encapsuleet extrait les interactions avec DynamoDB, et vous permet d'utiliser en toute simplicité les fonctions etl'interface de session natives de PHP.

// Start the sessionsession_start();

// Alter the session data$_SESSION['user.name'] = 'jeremy';$_SESSION['user.role'] = 'admin';

// Close the session (optional, but recommended)session_write_close();

ConfigurationVous pouvez configurer le comportement du gestionnaire de session à l'aide des options suivantes. Toutesles options sont facultatives, mais veillez à comprendre les valeurs par défaut.

table_name

Nom du tableau DynamoDB dans lequel stocker les sessions. La valeur par défaut est 'sessions'.hash_key

Nom de la clé de hachage dans le tableau de sessions DynamoDB. La valeur par défaut est 'id'.data_attribute

Nom de l'attribut dans la table de sessions DynamoDB dans laquelle sont stockées les données. Lavaleur par défaut est 'data'.

data_attribute_type

Type de l'attribut dans la table de sessions DynamoDB dans laquelle sont stockées les données. Lavaleur par défaut est 'string', mais elle peut éventuellement être définie sur 'binary'.

session_lifetime

La durée de vie d'une session inactive avant de devoir être nettoyée de la mémoire. Si elle n'est pasfournie, la valeur réelle de la durée de vie utilisée sera ini_get('session.gc_maxlifetime').

session_lifetime_attribute

Nom de l'attribut dans la table de sessions DynamoDB dans laquelle l'heure d'expiration de la sessionest stockée. La valeur par défaut est 'expires'.

101

https://console.aws.amazon.com/dynamodb/home

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html

AWS SDK pour PHP Manuel du développeurTarification

consistent_read

Indique si le gestionnaire de session doit utiliser des lectures cohérentes pour l'opération GetItem. Lavaleur par défaut est true.

locking

Indique s'il faut utiliser le verrouillage de session. La valeur par défaut est false.batch_config

Configuration utilisée pour la suppression par lots pendant le nettoyage de la mémoire. Cesoptions sont transmises directement dans les objets DynamoDB WriteRequestBatch. Déclenchezmanuellement le nettoyage de la mémoire via SessionHandler::garbageCollect().

max_lock_wait_time

Durée maximale (en secondes) pendant laquelle le gestionnaire de session doit attendre l'acquisitiond'un verrouillage avant d'abandonner. La valeur par défaut est 10 et est utilisée uniquement avec leverrouillage de session.

min_lock_retry_microtime

Durée minimale (en microsecondes) pendant laquelle le gestionnaire de session doit attendreentre deux tentatives d'acquisition d'un verrouillage. La valeur par défaut est 10000 et est utiliséeuniquement avec le verrouillage de session.

max_lock_retry_microtime

Durée maximale (en microsecondes) pendant laquelle le gestionnaire de session doit attendreentre deux tentatives d'acquisition d'un verrouillage. La valeur par défaut est 50000 et est utiliséeuniquement avec le verrouillage de session.

Pour configurer le Gestionnaire de sessions, spécifiez les options de configuration lorsque vous instanciezle gestionnaire. Le code suivant est un exemple avec toutes les options de configuration spécifiées.

$sessionHandler = SessionHandler::fromClient($dynamoDb, [ 'table_name' => 'sessions', 'hash_key' => 'id', 'data_attribute' => 'data', 'data_attribute_type' => 'string', 'session_lifetime' => 3600, 'session_lifetime_attribute' => 'expires', 'consistent_read' => true, 'locking' => false, 'batch_config' => [], 'max_lock_wait_time' => 10, 'min_lock_retry_microtime' => 5000, 'max_lock_retry_microtime' => 50000,]);

TarificationOutre le stockage des données et les frais de transfert de données, les coûts associés à l’utilisation deDynamoDB sont calculés en fonction de la capacité de débit alloué de votre tableau (voir les Informationsde tarification d’Amazon DynamoDB). Le débit est mesuré en unités de capacité d'écriture et de capacitéde lecture. La page d'accueil Amazon DynamoDB affiche :

Une unité de capacité de lecture représente une lecture à cohérence forte par seconde (ou deux lecturescohérentes à terme par seconde) pour des éléments dont la taille peut atteindre jusqu'à 4 Ko. Une unité

102

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.DynamoDb.WriteRequestBatch.html

https://aws.amazon.com/dynamodb/pricing/

https://aws.amazon.com/dynamodb/pricing/

AWS SDK pour PHP Manuel du développeurVerrouillage de la session

de capacité d'écriture représente une écriture par seconde pour des éléments dont la taille peut atteindrejusqu'à 1 Ko.

Enfin, le débit et les coûts nécessaires pour votre tableau de sessions seront corrélés au trafic attendu età la taille de session. Le tableau suivant explique la quantité d'opérations de lecture et d'écriture qui sontexécutées sur votre tableau DynamoDB pour chacune des fonctions de session.

Lecture via session_start() • 1 opération de lecture (uniquement 0,5 siconsistent_read est égal à false).

• (Conditionnel) 1 opération d'écriture poursupprimer la session si elle a expiré.

Lecture via session_start() (Utilisation deverrouillage de session)

• Un minimum de 1 opération d’écriture.• (Conditionnel) Opérations d'écriture

supplémentaires pour chaque tentative d'acquérirun verrouillage sur la session. En fonction dutemps d'attente entre les verrouillages et desoptions de nouvel essai.

• (Conditionnel) 1 opération d'écriture poursupprimer la session si elle a expiré.

Écriture via session_write_close() • 1 opération d'écriture.

Suppression via session_destroy() • 1 opération d'écriture.

Nettoyage de la mémoire • 0,5 opération de lecture par tranche de 4 Ko dedonnées du tableau à analyser pour les sessionsexpirées.

• 1 opération d’écriture par élément expiré poursupprimer celui-ci.

Verrouillage de la sessionLe Gestionnaire de sessions DynamoDB prend en charge le verrouillage de session pessimiste pour imiterle comportement du gestionnaire de sessions par défaut de PHP. Par défaut, cette fonction est désactivéesur le gestionnaire de session DynamoDB, car elle peut devenir un goulot d’étranglement et faire grimperles coûts, en particulier lorsqu’une application accède à la session en utilisant des demandes ou iframesAjax. Demandez-vous bien si votre application nécessite le verrouillage de session avant l'activation decelle-ci.

Pour activer le verrouillage de session, paramétrez l'option 'locking' sur true lorsque vous instanciezSessionHandler.

$sessionHandler = SessionHandler::fromClient($dynamoDb, [ 'table_name' => 'sessions', 'locking' => true,]);

Nettoyage de la mémoireConfigurez un attribut de la TTL dans votre tableau DynamoDB, à l'aide de l'attribut « expires ». Ainsi, lamémoire de vos sessions sera automatiquement nettoyée et vous n'aurez pas à le faire vous-même.

Le gestionnaire de sessions DynamoDB prend également en charge le nettoyage de la mémoirede session à l'aide d'une série d'opérations Scan et BatchWriteItem. En raison de la nature du

103

AWS SDK pour PHP Manuel du développeurBonnes pratiques

fonctionnement de l'opération Scan, et afin de trouver et supprimer toutes les sessions expirées, leprocessus de nettoyage de la mémoire peut exiger un débit alloué élevé.

Pour cette raison, nous ne prenons pas en charge le nettoyage de la mémoire automatisé. Une meilleurepratique consiste à planifier le nettoyage de la mémoire pendant les heures creuses, lorsqu'un pic de débitconsommé ne perturbera pas le reste de l'application. Par exemple, vous pouvez avoir une tâche cronnocturne déclenchant un script pour exécuter le nettoyage de la mémoire. Ce script doit faire quelquechose de similaire à ce qui suit.

$sessionHandler = SessionHandler::fromClient($dynamoDb, [ 'table_name' => 'sessions', 'batch_config' => [ 'batch_size' => 25, 'before' => function ($command) { echo "About to delete a batch of expired sessions.\n"; } ]]);

$sessionHandler->garbageCollect();

Vous pouvez également utiliser l'option 'before' au sein de 'batch_config' pour introduire des délaissur les opérations BatchWriteItem qui sont effectuées par le processus de nettoyage de la mémoire.Ceci augmentera le temps nécessaire pour terminer le nettoyage de la mémoire, mais peut vous aider àrépartir les demandes effectuées par le Gestionnaire de sessions DynamoDB pour vous aider à ne pas oupeu dépasser votre capacité de débit alloué pendant le nettoyage de la mémoire.

$sessionHandler = SessionHandler::fromClient($dynamoDb, [ 'table_name' => 'sessions', 'batch_config' => [ 'before' => function ($command) { $command['@http']['delay'] = 5000; } ]]);

$sessionHandler->garbageCollect();

Bonnes pratiques1. Créez votre tableau de sessions dans la région AWS la plus proche géographiquement ou dans la

même région que vos serveurs d'applications. Cela garantit une latence la plus faible possible entrevotre application et votre base de données DynamoDB.

2. Choisissez avec soin la capacité de débit alloué de votre tableau de sessions. Prenez en compte le traficattendu pour votre application et la taille attendue de vos sessions. Vous pouvez également utiliser lemode de capacité de lecture/écriture « à la demande » pour votre tableau.

3. Surveillez votre débit consommé via AWS Management Console ou avec Amazon CloudWatch, etréglez les paramètres de débit autant que nécessaire pour répondre aux besoins de votre application.

4. Maintenez des sessions de petite taille (idéalement inférieures à 1 Ko). Les sessions de petite taille sontplus performantes et nécessitent moins de capacité de débit alloué.

5. N'utilisez pas le verrouillage de session, sauf si votre application le nécessite.6. Au lieu d'utiliser les déclencheurs de nettoyage de la mémoire de session intégrés de PHP, programmez

votre nettoyage de la mémoire via une tâche cron ou autre mécanisme de planification, pour qu'elles'exécute pendant les heures creuses. Utilisez l'option 'batch_config' à votre avantage.

104

AWS SDK pour PHP Manuel du développeurAutorisations IAM nécessaires

Autorisations IAM nécessairesPour utiliser SessionHhandler DynamoDB, les informations d’identification configurées (p. 42) doivent avoirl’autorisation d’utiliser le tableau DynamoDB que vous avez créé dans une étape précédente (p. 101).La stratégie IAM suivante contient les autorisations nécessaires minimales. Pour utiliser cette stratégie,remplacez la valeur Resource par l'Amazon Resource Name (ARN) du tableau que vous avez crééprécédemment. Pour plus d’informations sur la création et l’attachement de stratégies IAM, consultez lasection Gestion des stratégies IAM dans le IAM User Guide.

{ "Version": "2012-10-17", "Statement": [ { "Action": [ "dynamodb:GetItem", "dynamodb:UpdateItem", "dynamodb:DeleteItem", "dynamodb:Scan", "dynamodb:BatchWriteItem" ], "Effect": "Allow", "Resource": "arn:aws:dynamodb:<region>:<account-id>:table/<table-name>" } ]}

Client sur plusieurs régions Amazon S3 avec le kitAWS SDK for PHP version 3

Le kit AWS SDK for PHP version 3 fournit un client sur plusieurs régions générique utilisable avec n’importequel service. Cela permet aux utilisateurs de spécifier vers quelle région AWS une commande doit êtreenvoyée en fournissant un paramètre d'entrée @region pour n'importe quelle commande. En outre, lekit SDK fournit un client sur plusieurs régions pour Amazon S3 qui répond intelligemment à des erreursspécifiques à Amazon S3 et redirige les commandes en conséquence. Cela permet aux utilisateursd'utiliser le même client pour parler à plusieurs régions. Cette fonction s’avère particulièrement utile pourles utilisateurs d’Amazon S3 Stream Wrapper avec le kit AWS SDK pour PHP version 3 (p. 106), dont lescompartiments résident dans plusieurs régions.

Utilisation de baseLe modèle d'utilisation de base d'un client Amazon S3 est toujours le même, que vous utilisiez un client S3standard ou son équivalent sur plusieurs régions. La seule différence en termes d'utilisation au niveau de lacommande est que la région AWS peut être spécifiée à l'aide du paramètre d'entrée @region.

// Create a multi-region S3 client$s3Client = (new \Aws\Sdk)->createMultiRegionS3(['version' => 'latest']);

// You can also use the client constructor$s3Client = new \Aws\S3\S3MultiRegionClient([ 'version' => 'latest', // Any Region specified while creating the client will be used as the // default Region 'region' => 'us-west-2',]);

105

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html

AWS SDK pour PHP Manuel du développeurCache de région d'un compartiment

// Get the contents of a bucket$objects = $s3Client->listObjects(['Bucket' => $bucketName]);

// If you would like to specify the Region to which to send a command, do so// by providing an @region parameter$objects = $s3Client->listObjects([ 'Bucket' => $bucketName, '@region' => 'eu-west-1',]);

Important

Lorsque vous utilisez le client Amazon S3 sur plusieurs régions, vous ne rencontrez pasd'exception de redirection permanente. Un client Amazon S3 standard génère une instance deAws\S3\Exception\PermanentRedirectException lorsqu’une commande est envoyée àla mauvaise région. Un client sur plusieurs régions, quant à lui, réexpédie la commande vers larégion appropriée.

Cache de région d'un compartimentLes clients Amazon S3 sur plusieurs régions gèrent un cache interne des régions AWS dans lesquellesrésident les compartiments donnés. Par défaut, chaque client possède son propre cache en mémoire.Pour partager un cache entre plusieurs clients ou processus, fournissez une instance de Aws\CacheInterface comme option bucket_region_cache à votre client sur plusieurs régions.

use Aws\DoctrineCacheAdapter;use Aws\Sdk;use Doctrine\Common\Cache\ApcuCache;

$sdk = new Aws\Sdk([ 'version' => 'latest', 'region' => 'us-west-2', 'S3' => [ 'bucket_region_cache' => new DoctrineCacheAdapter(new ApcuCache), ],]);

Encapsuleur de flux Amazon S3 avec le kit AWSSDK for PHP version 3

L’encapsuleur de flux Amazon S3 vous permet de stocker et de récupérer des données depuis Amazon S3à l’aide des fonctions PHP intégrées, telles que file_get_contents, fopen, copy, rename, unlink,mkdir et rmdir.

Vous devez enregistrer l'encapsuleur de flux Amazon S3 pour l'utiliser.

$client = new Aws\S3\S3Client([/** options **/]);

// Register the stream wrapper from an S3Client object$client->registerStreamWrapper();

Cela vous permet d’accéder aux compartiments et aux objets stockés dans Amazon S3 à l’aide duprotocole s3://. L’encapsuleur de flux Amazon S3 accepte les chaînes qui contiennent un nom decompartiment suivi par une barre oblique et une clé d’objet ou un préfixe en option : s3://<bucket>[/<key-or-prefix>].

106

AWS SDK pour PHP Manuel du développeurTéléchargement des données

Note

L'encapsuleur de flux est conçu pour fonctionner avec les objets et les compartiments sur lesquelsvous avez au moins une autorisation de lecture. Cela signifie que votre utilisateur doit avoirl'autorisation d'exécuter ListBucket sur les compartiments et GetObject sur les objets aveclesquels l'utilisateur doit interagir. S'il s'agit d'un cas d'utilisation pour lequel vous n'avez pas ceniveau d'autorisation, nous vous recommandons d'utiliser directement les opérations du client S3.

Téléchargement des donnéesVous pouvez saisir le contenu d'un objet en utilisant file_get_contents. Cependant, soyez prudentavec cette fonction, car elle charge tout le contenu de l'objet dans la mémoire.

// Download the body of the "key" object in the "bucket" bucket$data = file_get_contents('s3://bucket/key');

Utilisez fopen() lorsque vous travaillez avec des fichiers plus volumineux, ou si vous avez besoin dediffuser des données à partir de Amazon S3.

// Open a stream in read-only modeif ($stream = fopen('s3://bucket/key', 'r')) { // While the stream is still open while (!feof($stream)) { // Read 1,024 bytes from the stream echo fread($stream, 1024); } // Be sure to close the stream resource when you're done with it fclose($stream);}

Note

Des erreurs d'écriture du fichier sont renvoyées uniquement lorsqu'un appel à fflush esteffectué. Ces erreurs ne sont pas renvoyées lorsqu'un appel à fclose non vidé est effectué. Lavaleur de retour pour fclose sera de true s'il ferme le flux, quel que soit le nombre d'erreursen réponse à son fflush interne. Ces erreurs ne sont pas non plus renvoyées lors de l'appel àfile_put_contents, à cause de la façon dont PHP l'implémente.

Ouverture de flux ne pouvant être recherchésLes flux ouverts en mode « r » autorisent uniquement la lecture de données depuis le flux, et ne peuventpas être recherchés par défaut. Cela afin que les données puissent être téléchargées à partir de AmazonS3 comme s'il s'agissait d'un véritable streaming, où les octets précédemment lus n'ont pas besoin d'êtremis en mémoire tampon. Si vous avez besoin qu’un flux puisse être recherché, vous pouvez transférerseekable dans les options de contexte de flux d’une fonction.

$context = stream_context_create([ 's3' => ['seekable' => true]]);

if ($stream = fopen('s3://bucket/key', 'r', false, $context)) { // Read bytes from the stream fread($stream, 1024); // Seek back to the beginning of the stream fseek($stream, 0); // Read the same bytes that were previously read fread($stream, 1024); fclose($stream);}

107

http://www.php.net/manual/en/function.stream-context-create.php

AWS SDK pour PHP Manuel du développeurTéléchargement des données

Ouvrir des flux pouvant être recherchés vous permet de rechercher des octets qui ont été lus auparavant.Vous ne pouvez pas passer directement aux octets qui n'ont pas encore été lus depuis le serveur distant.Pour autoriser le rappel de données précédemment lues, les données sont mises en mémoire tampon dansun flux PHP temporaire à l'aide d'un décorateur de flux. Lorsque la quantité de données mises en cachedépasse 2 Mo, les données dans le flux temporaire sont transférées de la mémoire au disque. Gardez celaà l’esprit lorsque vous téléchargez des fichiers volumineux à partir de Amazon S3 à l’aide du paramètrecontextuel de flux seekable.

Téléchargement des donnéesVous pouvez télécharger des données dans Amazon S3 avec file_put_contents().

file_put_contents('s3://bucket/key', 'Hello!');

Vous pouvez télécharger des fichiers plus volumineux en diffusant les données en streaming à l'aide defopen() et d'un mode d'accès du flux « w », « x » ou « a ». L'encapsuleur de flux Amazon S3 ne prendpas en charge la lecture et l'écriture simultanées des flux (par ex. : « r+ », « w+ », etc.). Cela est dû au faitque le protocole HTTP ne permet pas la lecture et l'écriture simultanées.

$stream = fopen('s3://bucket/key', 'w');fwrite($stream, 'Hello!');fclose($stream);

Note

Amazon S3 exige de spécifier un en-tête Content-Length avant d'envoyer la charge utile d'unedemande. Par conséquent, les données à télécharger dans une opération PutObject sont misesen mémoire tampon grâce à un flux PHP temporaire jusqu'à ce que le flux soit vidé ou fermé.Note

Des erreurs d'écriture du fichier sont renvoyées uniquement lorsqu'un appel à fflush esteffectué. Ces erreurs ne sont pas renvoyées lorsqu'un appel à fclose non vidé est effectué. Lavaleur de retour pour fclose sera de true s'il ferme le flux, quel que soit le nombre d'erreursen réponse à son fflush interne. Ces erreurs ne sont pas non plus renvoyées lors de l'appel àfile_put_contents, à cause de la façon dont PHP l'implémente.

Modes fopenLa fonction PHP fopen() nécessite que vous indiquiez une option $mode. L'option de mode spécifie si lesdonnées peuvent être lues ou écrites dans un flux, et si le fichier doit exister lors de l'ouverture d'un flux.L'encapsuleur de flux Amazon S3 prend en charge les modes suivants.

r Un flux en lecture seule dans lequel le fichier doitdéjà exister.

s, sem Un flux en écriture seule. Si le fichier existe déjà, ilest remplacé.

a Un flux en écriture seule. Si le fichier existedéjà, il est téléchargé vers un flux temporaire ettoute écriture vers le flux est ajoutée à toutes lesdonnées chargées précédemment.

h/24, j/7 Un flux en écriture seule. Une erreur est générée sile fichier n'existe pas déjà.

108

http://php.net/manual/en/function.fopen.php

AWS SDK pour PHP Manuel du développeurAutres fonctions d'objet

Autres fonctions d'objetLes encapsuleurs de flux permettent le fonctionnement de nombreuses fonctions PHP intégrées avec unsystème personnalisé tel que Amazon S3. Voici certaines des fonctions que l’encapsuleur de flux AmazonS3 vous permet d’effectuer avec des objets stockés dans Amazon S3.

unlink() Pour supprimer un objet dans un compartiment.

// Delete an object from a bucketunlink('s3://bucket/key');

Vous pouvez transmettre toutes les optionsdisponibles pour l'opération DeleteObject afinde modifier la façon dont l'objet est supprimé(par exemple, en spécifiant une version d'objetspécifique).

// Delete a specific version of an object from a bucketunlink('s3://bucket/key', stream_context_create([ 's3' => ['VersionId' => '123']]);

filesize() Pour obtenir la taille d'un objet.

// Get the Content-Length of an object$size = filesize('s3://bucket/key', );

is_file() Pour vérifier si une URL est un fichier.

if (is_file('s3://bucket/key')) { echo 'It is a file!';}

file_exists() Pour vérifier si un objet existe.

if (file_exists('s3://bucket/key')) { echo 'It exists!';}

filetype() Vérifie si une URL est mappée à un fichier ou uncompartiment (dir).

dans le fichier() Pour charger le contenu d'un objet dans un tableaude lignes. Vous pouvez transmettre toute optiondisponible à l'opération GetObject pour modifierla façon dont le fichier est téléchargé.

filemtime() Pour obtenir la date à laquelle l'objet a été modifiépour la dernière fois.

rename() Pour renommer un objet en le copiant puis ensupprimant l'original. Vous pouvez transmettreles options disponibles pour les opérations

109

AWS SDK pour PHP Manuel du développeurUtilisation des compartiments

CopyObject et DeleteObject aux paramètresde contexte de flux pour modifier la façon dontl'objet est copié et supprimé.

Note

Bien que copy utilise généralement l'encapsuleur de flux Amazon S3, certaines erreurs peuventne pas être correctement signalées en raison d'éléments internes de la fonction copy dans PHP.Nous vous recommandons d’utiliser une instance de AwsS3ObjectCopier à la place.

Utilisation des compartimentsVous pouvez modifier et parcourir des compartiments Amazon S3 de manière similaire à la façon dont PHPautorise la modification et les parcours de répertoires sur votre système de fichiers.

Voici un exemple de création de compartiment.

mkdir('s3://bucket');

Vous pouvez transmettre les options contextuelles de flux à la méthode mkdir() pour modifier la façondont le compartiment est créé, grâce aux paramètres disponibles pour l’opération CreateBucket.

// Create a bucket in the EU (Ireland) Regionmkdir('s3://bucket', stream_context_create([ 's3' => ['LocationConstraint' => 'eu-west-1']]);

Vous pouvez supprimer des compartiments à l'aide de la fonction rmdir().

// Delete a bucketrmdir('s3://bucket');

Note

Un compartiment ne peut être supprimé que s'il est vide.

Affichage du contenu d'un compartimentVous pouvez utiliser les fonctions PHP opendir(), readdir(), rewinddir() et closedir() avec l’encapsuleur deflux Amazon S3 pour traverser les contenus d’un compartiment. Vous pouvez transmettre des paramètresdisponibles pour l’opération ListObjects en tant qu’options contextuelles de flux personnalisé à la fonctionopendir() afin de modifier la façon dont les objets sont répertoriés.

$dir = "s3://bucket/";

if (is_dir($dir) && ($dh = opendir($dir))) { while (($file = readdir($dh)) !== false) { echo "filename: {$file} : filetype: " . filetype($dir . $file) . "\n"; } closedir($dh);}

Vous pouvez répertorier de façon récursive chaque objet et préfixe dans un compartiment à l'aide de lafonction PHP RecursiveDirectoryIterator.

$dir = 's3://bucket';$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));

110

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.S3.ObjectCopier.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.S3.S3Client.html#_createBucket

http://www.php.net/manual/en/function.opendir.php

http://www.php.net/manual/en/function.readdir.php

http://www.php.net/manual/en/function.rewinddir.php

http://php.net/manual/en/function.closedir.php

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.S3Client.html#_listObjects

http://php.net/manual/en/class.recursivedirectoryiterator.php

AWS SDK pour PHP Manuel du développeurOptions de contexte de flux

foreach ($iterator as $file) { echo $file->getType() . ': ' . $file . "\n";}

Une autre façon de répertorier de façon récursive les contenus d'un compartiment, qui entraîne moinsde requêtes HTTP, est d'utiliser la fonction Aws\recursive_dir_iterator($path, $context =null).

<?phprequire 'vendor/autoload.php';

$iter = Aws\recursive_dir_iterator('s3://bucket/key');foreach ($iter as $filename) { echo $filename . "\n";}

Options de contexte de fluxVous pouvez personnaliser le client utilisé par l'encapsuleur de flux, ou le cache utilisé pour mettre encache les informations précédemment chargées sur les compartiments et les clés, en transmettant lesoptions de contexte de flux personnalisé.

L'encapsuleur de flux prend en charge les options de contexte de flux suivantes au niveau de chaqueopération.

client

L'objet Aws\AwsClientInterface à utiliser pour exécuter des commandes.cache

Une instance de Aws\CacheInterface à utiliser pour mettre en cache les statistiques des fichiersprécédemment obtenues. Par défaut, l'encapsuleur de flux utilise un cache LRU en mémoire.

Gestionnaire de transferts Amazon S3 avec le kitAWS SDK for PHP version 3

Le gestionnaire de transfert Amazon S3 dans le kit AWS SDK for PHP est utilisé pour charger desrépertoires entiers dans un compartiment Amazon S3 et télécharger des compartiments entiers dans unrépertoire local.

Chargement d'un répertoire local vers Amazon S3L'objet Aws\S3\Transfer est utilisé pour effectuer des transferts. L'exemple suivant montre commentcharger de façon récursive un répertoire local de fichiers dans un compartiment Amazon S3.

// Create an S3 client$client = new \Aws\S3\S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01',]);

// Where the files will be source from$source = '/path/to/source/files';

// Where the files will be transferred to

111

AWS SDK pour PHP Manuel du développeurTéléchargement d'un compartiment Amazon S3

$dest = 's3://bucket';

// Create a transfer object$manager = new \Aws\S3\Transfer($client, $source, $dest);

// Perform the transfer synchronously$manager->transfer();

Dans cet exemple, nous avons créé un client Amazon S3, un objet Transfer et effectué le transfert demanière synchrone. L'exemple précédent montre la quantité de code minimale nécessaire pour effectuerun transfert. L'objet de transfert peut effectuer des transferts de manière asynchrone et possède différentesoptions de configuration que vous pouvez utiliser pour personnaliser les transferts.

Vous pouvez charger les fichiers locaux dans un « sous-dossier » d'un compartiment Amazon S3 enfournissant un préfixe de clé dans l'URI s3://. L'exemple suivant télécharge les fichiers locaux sur ledisque pour le compartiment bucket et stocke les fichiers sous le préfixe de clé foo.

$source = '/path/to/source/files';$dest = 's3://bucket/foo';$manager = new \Aws\S3\Transfer($client, $source, $dest);$manager->transfer();

Téléchargement d'un compartiment Amazon S3Vous pouvez télécharger de manière récursive un compartiment Amazon S3 vers un répertoire local surle disque en spécifiant l’argument $source en tant qu’URI Amazon S3 (par exemple, s3://bucket) etl’argument $dest en tant que chemin d’accès à un répertoire local.

// Where the files will be sourced from$source = 's3://bucket';

// Where the files will be transferred to$dest = '/path/to/destination/dir';

$manager = new \Aws\S3\Transfer($client, $source, $dest);$manager->transfer();

Note

Le kit SDK crée automatiquement tous les répertoires nécessaires lors du téléchargement desobjets dans le compartiment.

Vous pouvez inclure un préfixe de clé dans l'URI Amazon S3 après le compartiment pour téléchargeruniquement les objets stockés sous un « pseudo-dossier ». L'exemple suivant télécharge uniquement lesfichiers stockés sous le préfixe de clé « /foo » du compartiment donné.

$source = 's3://bucket/foo';$dest = '/path/to/destination/dir';$manager = new \Aws\S3\Transfer($client, $source, $dest);$manager->transfer();

ConfigurationLe constructeur de l'objet Transfer accepte les arguments suivants.

$client

L'objet Aws\ClientInterface à utiliser pour effectuer les transferts.

112

AWS SDK pour PHP Manuel du développeurOptions de transfert

$source (string|``Iterator``)

Les données source concernées par le transfert. Cela peut pointer vers un chemin d’accès local surle disque (par exemple, /path/to/files) ou un compartiment Amazon S3 (par exemple, s3://bucket). L'URI s3:// peut également contenir un préfixe de clé qui peut être utilisé pour transféreruniquement les objets dotés d'un préfixe commun.

Si l’argument $source est un URI Amazon S3, l’argument $dest doit être un répertoire local (et viceversa).

En plus de fournir une valeur de chaîne, vous pouvez également fournir un objet \Iterator quigénère des noms de fichier absolus. Si vous fournissez un itérateur, vous devez fournir une optionbase_dir dans le tableau associatif $options.

$dest

La destination de transfert des fichiers. Si l’argument $source est un chemin d’accès local sur ledisque, $dest doit être un URI de compartiment Amazon S3 (par exemple, s3://bucket). Sil’argument $source est une URI de compartiment Amazon S3, l’argument $dest doit être un chemind’accès local sur le disque.

$options

Un tableau associatif d’options de transfert (p. 113).

Options de transfertbase_dir (chaîne)

Répertoire de base de la source, si $source est un itérateur. Si l'option $source n'est pas untableau, cette option est ignorée.

before (joignable)

Un rappel à invoquer avant chaque transfert. Les rappels doivent avoir une signature defonction telle que function (Aws\Command $command) {...}. La commande fournieest une commande GetObject, PutObject, CreateMultipartUpload, UploadPart ouCompleteMultipartUpload.

mup_threshold (int)

Taille en octets pour laquelle il est préférable d'utiliser un chargement partitionné au lieu dePutObject. Sa valeur par défaut est de 16777216 (16 Mo).

concurrency (int, default=5)

Nombre de fichiers à charger simultanément. La valeur de simultanéité idéale varie en fonction dunombre de fichiers en cours de chargement et de la taille moyenne de chaque fichier. En général, lespetits fichiers bénéficient d'une simultanéité plus élevée, contrairement aux fichiers plus volumineux.

debug (bool)

Définissez ce paramètre sur true pour imprimer les informations de débogage pour les transferts.Définissez ce paramètre sur une ressource fopen() pour écrire sur un flux spécifique au lieu d'écriresur STDOUT.

Transferts asynchronesL'objet Transfer est une instance de GuzzleHttp\Promise\PromisorInterface. Cela signifie quele transfert peut se produire de façon asynchrone et est initié en appelant la méthode de l'objet promise.

113

AWS SDK pour PHP Manuel du développeurPersonnalisation des commandes

du gestionnaire de transfert

$source = '/path/to/source/files';$dest = 's3://bucket';$manager = new \Aws\S3\Transfer($client, $source, $dest);

// Initiate the transfer and get a promise$promise = $manager->promise();

// Do something when the transfer is complete using the then() method$promise->then(function () { echo 'Done!';});

La promesse sera rejetée si le transfert de l'un des fichiers échoue. Vous pouvez gérer les transferts enéchec de façon asynchrone à l'aide de la méthode otherwise de la promesse. La fonction otherwiseaccepte un rappel pour invoquer lorsqu'une erreur se produit. Le rappel accepte la $reason du rejet, quisera généralement une instance de Aws\Exception\AwsException (même si une valeur de type anypeut être fournie au rappel).

$promise->otherwise(function ($reason) { echo 'Transfer failed: '; var_dump($reason);});

Etant donné que l'objet Transfer renvoie une promesse, ces transferts peuvent se produiresimultanément avec d'autres promesses asynchrones.

Personnalisation des commandes du gestionnaire detransfertVous pouvez définir des options personnalisées sur les opérations exécutées par le gestionnaire detransfert via un rappel transmis à son constructeur.

$uploader = new Transfer($s3Client, $source, $dest, [ 'before' => function (\Aws\Command $command) { // Commands can vary for multipart uploads, so check which command // is being processed if (in_array($command->getName(), ['PutObject', 'CreateMultipartUpload'])) { // Set custom cache-control metadata $command['CacheControl'] = 'max-age=3600'; // Apply a canned ACL $command['ACL'] = strpos($command['Key'], 'CONFIDENTIAL') ### false ? 'public-read' : 'private'; } },]);

Chiffrement côté client Amazon S3 avec le kit AWSSDK for PHP version 3

Le kit AWS SDK for PHP fournit S3EncryptionClient. Avec le chiffrement côté client, les données sontchiffrées et déchiffrées directement dans votre environnement. Cela signifie que ces données sont chiffréesavant d'être transférées vers Amazon S3 et que vous n'avez pas à utiliser un service externe qui gèrerait lechiffrement pour vous.

114

AWS SDK pour PHP Manuel du développeurSetup

Le kit AWS SDK for PHP implémente le chiffrement d’enveloppe et utilise OpenSSL pour le chiffrementet le déchiffrement. L’implémentation est interopérable avec d’autres kits SDK qui correspondent à sesfonctions. Elle est également compatible avec le kit SDK du flux de travail asynchrone basé sur lespromesses (p. 65).

SetupPour démarrer avec le chiffrement côté client, vous avez besoin des éléments suivants :

• Clé de chiffrement AWS KMS• Compartiment S3

Avant d'exécuter un exemple de code, configurez vos informations d'identification AWS. Consultez lasection Informations d’identification pour le kit AWS SDK pour PHP version 3 (p. 42).

ChiffrementLe chargement d'un objet chiffré par le biais de l'opération PutObject présente une interface similaire etnécessite deux nouveaux paramètres.

use Aws\S3\S3Client;use Aws\S3\Crypto\S3EncryptionClient;use Aws\Kms\KmsClient;use Aws\Crypto\KmsMaterialsProvider;

// Let's construct our S3EncryptionClient using an S3Client $encryptionClient = new S3EncryptionClient( new S3Client([ 'profile' => 'default', 'region' => 'us-east-1', 'version' => 'latest', ]) );

$kmsKeyArn = 'arn-to-the-kms-key'; // This materials provider handles generating a cipher key and // initialization vector, as well as encrypting your cipher key via AWS KMS $materialsProvider = new KmsMaterialsProvider( new KmsClient([ 'profile' => 'default', 'region' => 'us-east-1', 'version' => 'latest', ]), $kmsKeyArn );

$bucket = 'the-bucket-name'; $key = 'the-file-name'; $cipherOptions = [ 'Cipher' => 'gcm', 'KeySize' => 256, // Additional configuration options ];

$result = $encryptionClient->putObject([ '@MaterialsProvider' => $materialsProvider, '@CipherOptions' => $cipherOptions, 'Bucket' => $bucket, 'Key' => $key, 'Body' => fopen('file-to-encrypt.txt', 'r'),

115

https://docs.aws.amazon.com/kms/latest/developerguide/workflow.html

https://www.openssl.org/

https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html

https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html

https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html

https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html

AWS SDK pour PHP Manuel du développeurDéchiffrement

]);

Note

En plus des erreurs des services basés sur Amazon S3 et AWS KMS, il est possible que vousreceviez des objets émis InvalidArgumentException si vos '@CipherOptions' ne sontpas correctement configurées.

DéchiffrementLe téléchargement et le déchiffrement d'un objet nécessite un seul paramètre supplémentaire en plusde GetObject, et le client détectera les options de chiffrement de base pour vous. D'autres options deconfiguration sont transmises pour le déchiffrement.

$result = $encryptionClient->getObject([ '@MaterialsProvider' => $materialsProvider, '@CipherOptions' => [ // Additional configuration options ], 'Bucket' => $bucket, 'Key' => $key,]);

Note


Configuration de chiffrement'Cipher' (chaîne)

Méthode de chiffrement que le client de chiffrement utilise lors du chiffrement. A l'heure actuelle,seules les méthodes « gcm » et « cbc » sont prises en charge.

Important

PHP est mis à jour dans la version 7.1 pour inclure les paramètres supplémentaires nécessairespour chiffrer et déchiffrer à l’aide d’OpenSSL pour le chiffrement GCM. Par conséquent,l'utilisation de GCM avec votre Aws\S3\Crypto\S3EncryptionClient est uniquementdisponible sur PHP 7.1 ou une version ultérieure.

'KeySize' (int)

Longueur de la clé de chiffrement de contenu à générer pour le chiffrement. Valeur par défaut :256 bits. Les options de configuration valides sont 256, 192 et 128.

'Aad' (chaîne)

« Données d'authentification supplémentaires » facultatives à inclure à votre charge utile chiffrée. Cesinformations sont validées sur déchiffrement. Aad est disponible uniquement lorsque vous utilisez lechiffrement « gcm ».

116

http://php.net/manual/en/migration71.new-features.php

http://php.net/manual/en/function.openssl-encrypt.php

http://php.net/manual/en/function.openssl-decrypt.php

AWS SDK pour PHP Manuel du développeurStratégies de métadonnées

Stratégies de métadonnéesVous avez également la possibilité de fournir une instance d'une classe qui implémente Aws\Crypto\MetadataStrategyInterface. Cette interface simple gère l'enregistrement et le chargement deAws\Crypto\MetadataEnvelope qui contient vos supports de chiffrement d'enveloppe. Le kit SDKfournit deux classes qui implémentent ceci : Aws\S3\Crypto\HeadersMetadataStrategy et Aws\S3\Crypto\InstructionFileMetadataStrategy. HeadersMetadataStrategy est utilisé pardéfaut.

$strategy = new InstructionFileMetadataStrategy( $s3Client, '.instr');

$result = $encryptionClient->putObject([ '@MaterialsProvider' => $materialsProvider, '@MetadataStrategy' => $strategy, '@CipherOptions' => $cipherOptions, 'Bucket' => $bucket, 'Key' => $key, 'Body' => fopen('file-to-encrypt.txt'),]);

Les constantes de nom de classe HeadersMetadataStrategy etInstructionFileMetadataStrategy peuvent également être fournies en appelant ::class.

$result = $encryptionClient->putObject([ '@MaterialsProvider' => $materialsProvider, '@MetadataStrategy' => HeadersMetadataStrategy::class, '@CipherOptions' => $cipherOptions, 'Bucket' => $bucket, 'Key' => $key, 'Body' => fopen('file-to-encrypt.txt'),]);

Note

En cas d'échec après chargement d'un fichier d'instructions, il ne sera pas automatiquementsupprimé.

Chargements partitionnésIl est également possible d'exécuter un chargement partitionné avec un chiffrement côté client. Aws\S3\Crypto\S3EncryptionMultipartUploader prépare le flux source pour le chiffrement avant de lecharger. Sa création s'appuie sur une expérience similaire à l'utilisation de Aws\S3\MultipartUploaderet de Aws\S3\Crypto\S3EncryptionClient. S3EncryptionMultipartUploader peut traiter lamême option '@MetadataStrategy' que S3EncryptionClient, ainsi que toutes les configurations'@CipherOptions' disponibles.

$kmsKeyArn = 'arn-to-the-kms-key';// This materials provider handles generating a cipher key and// initialization vector, as well as encrypting your cipher key via AWS KMS$materialsProvider = new KmsMaterialsProvider( new KmsClient([ 'region' => 'us-east-1', 'version' => 'latest', 'profile' => 'default', ]),

117

AWS SDK pour PHP Manuel du développeurChargements partitionnés

$kmsKeyArn);

$bucket = 'the-bucket-name';$key = 'the-upload-key';$cipherOptions = [ 'Cipher' => 'gcm' 'KeySize' => 256, // Additional configuration options];

$multipartUploader = new S3EncryptionMultipartUploader( new S3Client([ 'region' => 'us-east-1', 'version' => 'latest', 'profile' => 'default', ]), fopen('large-file-to-encrypt.txt'), [ '@MaterialsProvider' => $materialsProvider, '@CipherOptions' => $cipherOptions, 'bucket' => 'bucket', 'key' => 'key', ]);$multipartUploader->upload();

Note


118

AWS SDK pour PHP Manuel du développeurInformations d'identification

Exemplesd e codes du kit AWS SDKfor PHP version 3

Le kit AWS SDK for PHP version 3 inclut des exemples de code qui illustrent des scénarios Amazon WebServices courants ayant recours au kit SDK.

L’intégralité de l’exemple de code pour le kit AWS SDK for PHP version 3 est disponible sur cette pageGitHub.

Informations d'identificationAvant d’exécuter l’exemple de code, configurez vos informations d’identification AWS comme indiqué dansla section Informations d’identification pour le kit AWS SDK pour PHP version 3 (p. 42). Importez ensuite lekit AWS SDK for PHP comme indiqué dans la section Modèles d’utilisation basiques du kit AWS SDK pourPHP version 3 (p. 7).

Rubriques• Exemples Amazon CloudFront utilisant le kit AWS SDK for PHP version 3 (p. 119)• Signature des demandes de domaine personnalisées Amazon CloudSearch avec le kit AWS SDK for

PHP version 3 (p. 134)• Exemples Amazon CloudWatch utilisant le kit AWS SDK for PHP version 3 (p. 135)• Exemples Amazon EC2 avec le kit AWS SDK for PHP version 3 (p. 146)• Signature d’une demande de recherche Amazon Elasticsearch Service avec le kit AWS SDK for PHP

version 3 (p. 157)• Exemples AWS IAM avec le kit AWS SDK for PHP version 3 (p. 158)• Exemples AWS Key Management Service utilisant le kit AWS SDK for PHP version 3 (p. 176)• Exemples Amazon Kinesis utilisant le kit AWS SDK for PHP version 3 (p. 193)• AWS Elemental MediaConvert Exemples utilisant le kit AWS SDK for PHP version 3 (p. 206)• Exemples Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 213)• Gestion des secrets à l'aide de l'API Secrets Manager et du kit AWS SDK for PHP version 3 (p. 233)• Exemples Amazon SES avec le kit AWS SDK for PHP version 3 (p. 240)• Exemples Amazon SNS avec le kit AWS SDK for PHP version 3 (p. 263)• Exemples Amazon SQS avec le kit AWS SDK for PHP version 3 (p. 277)

Exemples Amazon CloudFront utilisant le kit AWSSDK for PHP version 3

Amazon CloudFront est un service Web AWS qui accélère la remise de contenus Web statiques etdynamiques à partir de votre propre serveur Web ou d'un serveur AWS comme Amazon S3. CloudFrontfournit du contenu via un réseau mondial de centres de données appelés « emplacements périphériques ».Lorsqu'un utilisateur demande du contenu que vous distribuez avec CloudFront, il est dirigé versl'emplacement périphérique qui fournit la latence la plus faible. Si le contenu n'y est pas déjà mis en cache,

119

https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/php/example_code


AWS SDK pour PHP Manuel du développeurGestion des distributions CloudFront

CloudFront récupère une copie à partir du serveur d'origine, la remet, puis la met en cache pour les futuresdemandes.

Pour plus d'informations sur l'utilisation de CloudFront, consultez le Manuel du développeur AmazonCloudFront.


Rubriques• Gestion des distributions Amazon CloudFront à l'aide de l'API CloudFront et du kit AWS SDK for PHP

version 3 (p. 120)• Gestion des invalidations Amazon CloudFront à l'aide de l'API CloudFront et du kit AWS SDK for PHP

version 3 (p. 127)• Signature des URL Amazon CloudFront avec le kit AWS SDK for PHP version 3 (p. 130)

Gestion des distributions Amazon CloudFront à l'aidede l'API CloudFront et du kit AWS SDK for PHPversion 3Amazon CloudFront met en cache du contenu dans des emplacements périphériques du monde entier afind'accélérer la distribution de fichiers statiques et dynamiques que vous stockez sur votre propre serveur,ou sur un service Amazon comme Amazon S3 ou Amazon EC2. Lorsque des utilisateurs demandent ducontenu à partir de votre site web, CloudFront le remet à partir de l'emplacement périphérique le plusproche, si le fichier y est mis en cache. Sinon, CloudFront récupère une copie du fichier, le remet, puis lemet en cache pour la demande suivante. La mise en cache du contenu dans un emplacement périphériquepermet de réduire la latence des demandes similaires des utilisateurs de cette zone.

Pour chaque distribution CloudFront que vous créez, vous spécifiez où le contenu se trouve et la manièrede le distribuer lorsque les utilisateurs font des demandes. Cette rubrique porte sur les distributionspour les fichiers statiques et dynamiques tels que les fichiers HTML, CSS, JSON et d'image. Pour plusd'informations sur l'utilisation de CloudFront avec la vidéo à la demande, consultez Vidéo à la demande eten streaming en direct avec CloudFront.

Les exemples suivants montrent comment :

• Créer une distribution en utilisant CreateDistribution.• Obtenir une distribution en utilisant GetDistribution.• Répertorier les distributions en utilisant ListDistributions.• Mettre à jour des distributions en utilisant UpdateDistributions.• Désactiver des distributions en utilisant DisableDistribution.

120

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/




https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/on-demand-streaming-video.html

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/on-demand-streaming-video.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#createdistribution

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#getdistribution

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#listdistributions

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#updatedistribution

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#disabledistribution


• Supprimer des distributions en utilisant DeleteDistributions.



Pour plus d'informations sur l'utilisation d'Amazon CloudFront, consultez le Manuel du développeurAmazon CloudFront.

Création d'une distribution CloudFrontCréez une distribution à partir d'un compartiment Amazon S3. Dans l'exemple suivant, les paramètresfacultatifs sont mis en commentaire, mais les valeurs par défaut sont affichées. Pour ajouter despersonnalisations à votre distribution, supprimez la mise en commentaire de la valeur et du paramètre àl'intérieur de $distribution.

Pour créer une distribution CloudFront, utilisez l'opération CreateDistribution.

Importations


use Aws\CloudFront\CloudFrontClient; use Aws\Exception\AwsException;

Exemple de code

$client = new Aws\CloudFront\CloudFrontClient([ 'profile' => 'default', 'version' => '2018-06-18', 'region' => 'us-east-2']);

$originName = 'Name to identify the S3 bucket';$s3BucketURL = '<bucket-name>.s3.amazonaws.com';$callerReference = 'unique string';$comment = 'Created by AWS SDK for PHP';$cacheBehavior = [

'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['HEAD', 'GET'], 'Quantity' => 2, ], 'Items' => ['HEAD', 'GET'], 'Quantity' => 2, ], 'Compress' => false, 'DefaultTTL' => 0, 'FieldLevelEncryptionId' => '', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none', ],

121

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#deletedistribution





https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html


'Headers' => [ 'Quantity' => 0, ], 'QueryString' => false, 'QueryStringCacheKeys' => [ 'Quantity' => 0, ], ], 'LambdaFunctionAssociations' => ['Quantity' => 0], 'MaxTTL' => 0, 'MinTTL' => 0, 'SmoothStreaming' => false, 'TargetOriginId' => $originName, 'TrustedSigners' => [ 'Enabled' => false, 'Quantity' => 0, ], 'ViewerProtocolPolicy' => 'allow-all',];$enabled = false;$origin = [ 'Items' => [ [ 'DomainName' => $s3BucketURL, 'Id' => $originName, 'OriginPath' => '', 'CustomHeaders' => ['Quantity' => 0], 'S3OriginConfig' => ['OriginAccessIdentity' => ''],

], ], 'Quantity' => 1,];

/* * $cache = [ * 'Quantity' => 0, * ]; * $rootObject = '<string>'; * $alias = [ * 'Quantity' => 0, * ]; * $customError = [ * 'Quantity' => 0, * ]; * $httpVersion = 'http1.1'; * $IPV6 = false; * $logging = [ * 'Bucket' => '', * 'Enabled' => false, * 'IncludeCookies' => false, * 'Prefix' => '', * ]; * $priceClass = 'PriceClass_100'; * $restrictions = [ * 'GeoRestriction' => [ * 'Quantity' => 0, * 'RestrictionType' => 'none', * ], * ]; * $viewerCert = [ * 'CertificateSource' => 'cloudfront', * 'CloudFrontDefaultCertificate' => true, * 'MinimumProtocolVersion' => 'TLSv1', * ]; * $webACLid = '';

122


*/

$distribution = [ 'CallerReference' => $callerReference, 'Comment' => $comment, 'DefaultCacheBehavior' => $cacheBehavior, 'Enabled' => $enabled, 'Origins' => $origin, //'CacheBehaviors' => $cache, //'DefaultRootObject' => $rootObject, //'Aliases' => $alias, //'CustomErrorResponses' => $customError, //'HttpVersion' => $httpVersion, //'IsIPV6Enabled' => $IPV6, //'Logging' => $logging, //'PriceClass' => $priceClass, //'Restrictions' => $restrictions, //'ViewerCertificate' => $viewerCert, //'WebACLId' => $webACLid,];

try { $result = $client->createDistribution([ 'DistributionConfig' => $distribution, //REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Récupérer une distribution CloudFrontPour récupérer l'état et les détails relatifs à une distribution CloudFront, utilisez l'opération GetDistribution.

Importations



Exemple de code


$distributionId = 'E1A2B3C4D5E';

try { $result = $client->getDistribution([ 'Id' => $distributionId, //REQUIRED ]); print("<p>The Distribution " . $result['Distribution']['Id'] . " is currently " . $result['Distribution']['Status'] . "</p>"); var_dump($result);} catch (AwsException $e) {

123

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html


// output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier les distributions CloudFrontObtenez une liste des distributions CloudFront existantes dans la région AWS spécifiée, à partir de votrecompte actuel, en utilisant l'opération ListDistributions.

Importations



Exemple de code


try { $result = $client->listDistributions([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Mettre à jour une distribution CloudFrontLa mise à jour d'une distribution CloudFront est similaire à la création d'une distribution. Toutefois,lorsque vous mettez à jour une distribution, davantage de champs sont obligatoires et toutes les valeursdoivent être incluses. Pour apporter des modifications à une distribution, nous vous recommandons toutd'abord de la récupérer, puis de mettre à jour les valeurs que vous souhaitez modifier dans le tableau$distribution.

Pour mettre à jour une distribution CloudFront précise, utilisez l'opération UpdateDistribution.

Importations



Exemple de code

$client = new Aws\CloudFront\CloudFrontClient([

124

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributions.html

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html


'profile' => 'default', 'version' => '2018-06-18', 'region' => 'us-east-2']);

$id = 'E1A2B3C4D5E';

try { $result = $client->getDistribution([ 'Id' => $id, ]);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

$currentConfig = $result["Distribution"]["DistributionConfig"];$ETag = $result["ETag"];

$distribution = [ 'CallerReference' => $currentConfig["CallerReference"], // REQUIRED 'Comment' => $currentConfig["Comment"], // REQUIRED 'DefaultCacheBehavior' => $currentConfig["DefaultCacheBehavior"], // REQUIRED 'DefaultRootObject' => $currentConfig["DefaultRootObject"], 'Enabled' => $currentConfig["Enabled"], // REQUIRED 'Origins' => $currentConfig["Origins"], // REQUIRED 'Aliases' => $currentConfig["Aliases"], 'CustomErrorResponses' => $currentConfig["CustomErrorResponses"], 'HttpVersion' => $currentConfig["HttpVersion"], 'CacheBehaviors' => $currentConfig["CacheBehaviors"], 'Logging' => $currentConfig["Logging"], 'PriceClass' => $currentConfig["PriceClass"], 'Restrictions' => $currentConfig["Restrictions"], 'ViewerCertificate' => $currentConfig["ViewerCertificate"], 'WebACLId' => $currentConfig["WebACLId"],];

try { $result = $client->updateDistribution([ 'DistributionConfig' => $distribution, 'Id' => $id, 'IfMatch' => $ETag ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Désactiver une distribution CloudFrontPour désactiver ou supprimer une distribution, faites passer son état de la valeur « deployed » (déployée) àla valeur « disabled » (désactivée).

Pour désactiver la distribution CloudFront spécifiée, utilisez l'opération DisableDistribution.

Importations

125

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DisableDistribution.html




Exemple de code




$enabled = false;$currentConfig = $result["Distribution"]["DistributionConfig"];$ETag = $result["ETag"];

$distribution = [ 'CacheBehaviors' => $currentConfig["CacheBehaviors"], //REQUIRED 'CallerReference' => $currentConfig["CallerReference"], // REQUIRED 'Comment' => $currentConfig["Comment"], // REQUIRED 'DefaultCacheBehavior' => $currentConfig["DefaultCacheBehavior"], // REQUIRED 'DefaultRootObject' => $currentConfig["DefaultRootObject"], 'Enabled' => $enabled, // REQUIRED 'Origins' => $currentConfig["Origins"], // REQUIRED 'Aliases' => $currentConfig["Aliases"], 'CustomErrorResponses' => $currentConfig["CustomErrorResponses"], 'HttpVersion' => $currentConfig["HttpVersion"], 'IsIPV6Enabled' => $currentConfig["IsIPV6Enabled"], 'Logging' => $currentConfig["Logging"], 'PriceClass' => $currentConfig["PriceClass"], 'Restrictions' => $currentConfig["Restrictions"], 'ViewerCertificate' => $currentConfig["ViewerCertificate"], 'WebACLId' => $currentConfig["WebACLId"],];

//var_dump($distribution);

try { $result = $client->updateDistribution([ 'DistributionConfig' => $distribution, 'Id' => $id, 'IfMatch' => $ETag ]); print("<p>For The Distribution " . $result['Distribution']['Id'] . " enabled is set to " . $result['Distribution']['DistributionConfig']['Enabled'] . "</p>"); var_dump($result['Distribution']['DistributionConfig']['Enabled']);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

126

AWS SDK pour PHP Manuel du développeurGestion des invalidations CloudFront

Supprimer une distribution CloudFrontUne fois qu'une distribution est à l'état désactivé, vous pouvez la supprimer.

Pour supprimer une distribution CloudFront précise, utilisez l'opération DeleteDistribution.

Importations



Exemple de code




$ETag = $result["ETag"];

try { $result = $client->deleteDistribution([ 'Id' => $id, 'IfMatch' => $ETag ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Gestion des invalidations Amazon CloudFront àl'aide de l'API CloudFront et du kit AWS SDK for PHPversion 3Amazon CloudFront met en cache des copies de fichiers statiques et dynamiques dans des emplacementspériphériques du monde entier. Pour supprimer ou mettre à jour un fichier dans tous les emplacementspériphériques, créez une invalidation pour chaque fichier ou pour un groupe de fichiers.

127

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DeleteDistribution.html


Chaque mois calendaire, vos 1 000 premières invalidations sont gratuites. Pour en savoir plus sur lasuppression de contenu d'un emplacement périphérique CloudFront, consultez Invalidation de fichiers.


• Créer une invalidation de distribution en utilisant CreateInvalidation.• Obtenir une invalidation de distribution en utilisant GetInvalidation.• Répertorier les invalidations de distribution en utilisant ListInvalidations.




Créer une invalidation de distributionCréez une invalidation de distribution CloudFront en spécifiant l'emplacement des fichiers à supprimer. Cetexemple invalide tous les fichiers de la distribution, mais vous pouvez identifier des fichiers spécifiquessous Items.

Pour créer une invalidation de distribution CloudFront, utilisez l'opération CreateInvalidation.

Importations



Exemple de code

// Create a CloudFront Client$client = new Aws\CloudFront\CloudFrontClient([ 'profile' => 'default', 'version' => '2018-06-18', 'region' => 'us-east-2']);

$id = 'E1A2B3C4D5E';$callerReference = 'STRING';

try { $result = $client->createInvalidation([ 'DistributionId' => $id, 'InvalidationBatch' => [ 'CallerReference' => $callerReference, 'Paths' => [ 'Items' => ['/*'], 'Quantity' => 1, ],

128

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#createinvalidation

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#getinvalidation

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cloudfront-2018-11-05.html#listinvalidations





https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateInvalidation.html


] ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Obtenir une invalidation de distributionPour récupérer l'état et les détails relatifs à une invalidation de distribution CloudFront, utilisez l'opérationGetInvalidation.

Importations



Exemple de code


$distributionId = 'E1A2B3C4D5E';$invalidationID = 'I1A2B3C4D5E6F7G';

try { $result = $client->getInvalidation([ 'DistributionId' => $distributionId, 'Id' => $invalidationID, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier les invalidations de distributionPour répertorier toutes les invalidations de distribution CloudFront actuelles, utilisez l'opérationListInvalidations.

Importations



129

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetInvalidation.html

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListInvalidations.html

AWS SDK pour PHP Manuel du développeurSignature d'URL CloudFront

Exemple de code


$distributionId = 'E1A2B3C4D5E';

try { $result = $client->listInvalidations([ 'DistributionId' => $distributionId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Signature des URL Amazon CloudFront avec le kitAWS SDK for PHP version 3Les URL signées vous permettent de fournir aux utilisateurs l'accès à votre contenu privé. Une URLsignée inclut des informations supplémentaires (par exemple, une heure d'expiration) qui vous permettentde mieux contrôler l'accès à votre contenu. Ces informations supplémentaires apparaissent dans unedéclaration de stratégie, basée sur une stratégie prédéfinie ou une stratégie personnalisée. Pour de plusamples informations sur la procédure de configuration des distributions privées et la raison pour laquellevous devez signer des URL, veuillez consulter Service d'un contenu privé via Amazon CloudFront dans leAmazon CloudFront Developer Guide.

• Créer une URL Amazon CloudFront signée en utilisant getSignedURL.• Créer un cookie Amazon CloudFront signé en utilisant getSignedCookie.




Signature d'URL CloudFront pour les distributions privéesVous pouvez signer une URL à l'aide du client CloudFront dans le kit SDK. Tout d'abord, vous devez créerun objet CloudFrontClient. Vous pouvez signer une URL CloudFront pour une ressource vidéo à l'aided'une stratégie prédéfinie ou personnalisée.

Importations

130

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.CloudFront.CloudFrontClient.html#_getSignedUrl

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.CloudFront.CloudFrontClient.html#_getSignedCookie







use Aws\CloudFront\CloudFrontClient;use Aws\Exception\AwsException;

Exemple de code


// Set up parameter values for the resource$resourceKey = 'rtmp://example-distribution.cloudfront.net/videos/example.mp4';$expires = time() + 300;

// Create a signed URL for the resource using the canned policy$signedUrlCannedPolicy = $client->getSignedUrl([ 'url' => $resourceKey, 'expires' => $expires, 'private_key' => '/path/to/your/cloudfront-private-key.pem', 'key_pair_id' => '<CloudFront key pair id>']);

Utiliser une stratégie personnalisée lors de la création d'URLCloudFrontPour utiliser une stratégie personnalisée, fournissez la clé policy à la place de expires.

Importations



Exemple de code

// Create a CloudFront Client$client = new Aws\CloudFront\CloudFrontClient([ 'profile' => 'default', 'version' => '2014-11-06', 'region' => 'us-east-2']);// Set up parameter values for the resource$customPolicy = <<<POLICY{ "Statement": [ { "Resource": "{$resourceKey}", "Condition": { "IpAddress": {"AWS:SourceIp": "{$_SERVER['REMOTE_ADDR']}/32"}, "DateLessThan": {"AWS:EpochTime": {$expires}} } }

131


]}POLICY;

$resourceKey = 'rtmp://example-distribution.cloudfront.net/videos/example.mp4';

// Create a signed URL for the resource using the canned policy$signedUrlCannedPolicy = $client->getSignedUrl([ 'url' => $resourceKey, 'policy' => $customPolicy, 'private_key' => '/path/to/your/cloudfront-private-key.pem', 'key_pair_id' => '<CloudFront key pair id>']);foreach ($signedUrlCannedPolicy as $name => $value) { setcookie($name, $value, 0, "", "example-distribution.cloudfront.net", true, true);}

Utiliser une URL CloudFront signéeLa forme de l'URL signée diffère selon que l'URL que vous signez utilise le schéma « HTTP » ou« RTMP ». Dans le cas du schéma « HTTP », l'intégralité de l'URL absolue est renvoyée. Dans le cas duschéma « RTMP », seule l'URL relative est renvoyée pour simplifier le processus. Cela est dû au fait quecertains lecteurs exigent que l'hôte et le chemin soient fournis en tant que paramètres séparés.

L’exemple suivant montre comment utiliser l’URL signée pour construire une page Web affichant une vidéoà l’aide de JWPlayer. Cette technique s’applique également aux autres lecteurs, comme FlowPlayer, maisnécessite un code différent côté client.

<html><head> <title>|CFlong| Streaming Example</title> <script type="text/javascript" src="https://example.com/jwplayer.js"></script></head><body> <div id="video">The canned policy video will be here.</div> <script type="text/javascript"> jwplayer('video').setup({ file: "<?= $streamHostUrl ?>/cfx/st/<?= $signedUrlCannedPolicy ?>", width: "720", height: "480" }); </script></body></html>

Signature de cookies CloudFront pour les distributions privéesAu lieu d'utiliser des URL signées, vous pouvez également fournir aux clients l'accès à une distributionprivée via des cookies signés. Les cookies signés vous permettent de fournir l'accès à plusieurs fichiersrestreints : par exemple, tous les fichiers d'une vidéo au format HLS ou tous les fichiers de la section desabonnés d'un site web. Pour de plus amples informations sur les raisons pour lesquelles vous pouvezutiliser des cookies signés à la place des URL signées (ou inversement), veuillez consulter Choix entre lesURL signées et les cookies signés dans le Amazon CloudFront Developer Guide.

La création d'un cookie signé est similaire à celle d'une URL signée. La seule différence est la méthodeappelée (getSignedCookie au lieu de getSignedUrl).

Importations


132

http://www.longtailvideo.com/jw-player/

http://flowplayer.org/

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-choosing-signed-urls-cookies.html

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-choosing-signed-urls-cookies.html



Exemple de code


// Set up parameter values for the resource$resourceKey = 'https://example-distribution.cloudfront.net/videos/example.mp4';$expires = time() + 300;

// Create a signed cookie for the resource using the canned policy$signedCookieCannedPolicy = $client->getSignedCookie([ 'url' => $resourceKey, 'expires' => $expires, 'private_key' => '/path/to/your/cloudfront-private-key.pem', 'key_pair_id' => '<CloudFront key pair id>']);

Utiliser une stratégie personnalisée lors de la création de cookiesCloudFrontComme avec getSignedUrl, vous pouvez fournir un paramètre 'policy' à la place d'un paramètreexpires et d'un paramètre url pour signer un cookie avec une stratégie personnalisée. Une stratégiepersonnalisée peut contenir des caractères génériques dans la ressource clé. Cela vous permet de créerun seul cookie signé pour plusieurs fichiers.

getSignedCookie renvoie un tableau de paires clé-valeur. Toutes ces paires doivent être définiescomme des cookies pour accorder l'accès à une distribution privée.

Importations



Exemple de code


// Set up parameter values for the resource$resourceKey = 'https://example-distribution.cloudfront.net/videos/example.mp4';$customPolicy = <<<POLICY{ "Statement": [

133

AWS SDK pour PHP Manuel du développeurAmazon CloudSearch

{ "Resource": "{$resourceKey}", "Condition": { "IpAddress": {"AWS:SourceIp": "{$_SERVER['REMOTE_ADDR']}/32"}, "DateLessThan": {"AWS:EpochTime": {$expires}} } } ]}POLICY;

// Create a signed cookie for the resource using a custom policy$signedCookieCustomPolicy = $client->getSignedCookie([ 'policy' => $customPolicy, 'private_key' => '/path/to/your/cloudfront-private-key.pem', 'key_pair_id' => '<CloudFront key pair id>']);

foreach ($signedCookieCustomPolicy as $name => $value) { setcookie($name, $value, 0, "", "example-distribution.cloudfront.net", true, true);}

Envoyer des cookies CloudFront à un client GuzzleVous pouvez également transmettre ces cookies à un GuzzleHttp\Cookie\CookieJar pour uneutilisation avec un client Guzzle.

use GuzzleHttp\Client;use GuzzleHttp\Cookie\CookieJar;

$distribution = "example-distribution.cloudfront.net";$client = new \GuzzleHttp\Client([ 'base_uri' => "https://$distribution", 'cookies' => CookieJar::fromArray($signedCookieCustomPolicy, $distribution),]);

$client->get('video.mp4');

Pour de plus amples informations, veuillez consulter Utilisation de cookies signés dans le AmazonCloudFront Developer Guide.

Signature des demandes de domainepersonnalisées Amazon CloudSearch avec le kitAWS SDK for PHP version 3

Il est possible de personnaliser les demandes de domaine Amazon CloudSearch au-delà de ce qui estpris en charge par le kit AWS SDK for PHP. Dans les cas où vous avez besoin d'effectuer des demandespersonnalisées vers des domaines protégés par l'authentification IAM, vous pouvez utiliser les informationsd'identification des fournisseurs et des utilisateurs du kit SDK pour signer n'importe quelle demande PSR-7.

Par exemple, si vous suivez le Guide de démarrage Cloud Search et que vous souhaitez utiliser undomaine protégé par IAM pour l'étape 3, vous devez signer et exécuter votre demande comme suit.


• Signer une demande avec le protocole de signature AWS en utilisant SignatureV4.

134

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-signed-cookies.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Psr.Http.Message.RequestInterface.html

https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-started.html

https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-started-search.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Signature.SignatureV4.html#_signRequest




Signer une demande de domaine CSlongImportations

use Aws\Credentials\CredentialProvider;use Aws\Signature\SignatureV4;use GuzzleHttp\Client;use GuzzleHttp\Psr7\Request;

Exemple de code

// Prepare a CloudSearch domain request$request = new Request( 'GET', 'https://<your-domain>.<region-of-domain>.cloudsearch.amazonaws.com/2013-01-01/search?q=star+wars&return=title');

// Get your credentials from the environment$credentials = call_user_func(CredentialProvider::defaultProvider())->wait();

// Construct a request signer$signer = new SignatureV4('cloudsearch', '<region-of-domain>');

// Sign the request$request = $signer->signRequest($request, $credentials);

// Send the request$response = (new Client)->send($request);$results = json_decode($response->getBody());if ($results->hits->found > 0) { echo $results->hits->hit[0]->fields->title . "\n";}

Exemples Amazon CloudWatch utilisant le kit AWSSDK for PHP version 3

Amazon CloudWatch (CloudWatch) est un service web qui surveille en temps réel vos ressourcesAmazon Web Services (AWS) et les applications que vous exécutez sur AWS. Vous pouvez utiliserCloudWatch pour collecter et suivre les métriques, qui sont des variables qui vous permettent de mesurervos ressources et applications. Les alarmes CloudWatch envoient des notifications ou apportent desmodifications automatiquement aux ressources surveillées, selon les règles que vous définissez.

135






Rubriques• Utilisation des alarmes Amazon CloudWatch avec le kit AWS SDK for PHP version 3 (p. 136)• Obtention de métriques à partir d’Amazon CloudWatch avec le kit AWS SDK for PHP

version 3 (p. 138)• Publication de métriques personnalisées dans Amazon CloudWatch avec le kit AWS SDK for PHP

version 3 (p. 141)• Envoi d’événements à Amazon CloudWatch Events avec le kit AWS SDK for PHP version 3 (p. 142)• Utilisation d’actions d’alarme avec les alarmes Amazon CloudWatch avec le kit AWS SDK for PHP

version 3 (p. 145)

Utilisation des alarmes Amazon CloudWatch avec lekit AWS SDK for PHP version 3Une alarme Amazon CloudWatch surveille une seule métrique pendant la période que vous spécifiez. Elleréalise une ou plusieurs actions en fonction de la valeur de la métrique par rapport à un seuil donné sur uncertain nombre de périodes.


• Décrire une alarme à l’aide de DescribeAlarms.• Créer une alarme à l’aide de PutMetricAlarm.• Supprimer une alarme à l’aide de DeleteAlarms.


Informations d'identificationAvant d’exécuter l’exemple de code, configurez vos informations d’identification AWS comme indiqué dansla section Informations d’identification pour le kit AWS SDK pour PHP version 3 (p. 42). Importez ensuite le

136



https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#describealarms

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#putmetricalarm

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#deletealarms



AWS SDK pour PHP Manuel du développeurUtilisation des alarmes Amazon CloudWatch

kit AWS SDK for PHP comme indiqué dans la section Modèles d’utilisation basiques du kit AWS SDK pourPHP version 3 (p. 7).

Description des alarmesImportations


use Aws\CloudWatch\CloudWatchClient; use Aws\Exception\AwsException;

Exemple de code

$client = new Aws\CloudWatch\CloudWatchClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2010-08-01']);

try { $result = $client->describeAlarms([ ]); foreach ($result['MetricAlarms'] as $alarm) { echo $alarm['AlarmName'] . "\n"; }} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Créer une alarmeImportations



Exemple de code


try { $result = $client->putMetricAlarm(array( // AlarmName is required 'AlarmName' => 'string', // MetricName is required 'MetricName' => 'string', // Namespace is required 'Namespace' => 'string',

137

AWS SDK pour PHP Manuel du développeurObtention de métriques à partir d’Amazon CloudWatch

// Statistic is required //string: SampleCount | Average | Sum | Minimum | Maximum 'Statistic' => 'string', // Period is required 'Period' => integer, 'Unit' => 'Count/Second', // EvaluationPeriods is required 'EvaluationPeriods' => integer, // Threshold is required 'Threshold' => integer, // ComparisonOperator is required // string: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold 'ComparisonOperator' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Suppression d'alarmesImportations



Exemple de code


try { $result = $client->deleteAlarms([ 'AlarmNames' => [$alarmName] // REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Obtention de métriques à partir d’Amazon CloudWatchavec le kit AWS SDK for PHP version 3Les métriques sont des données sur les performances de vos systèmes. Vous pouvez activer lasurveillance détaillée de certaines ressources, telles que vos instances Amazon EC2 ou de vos propresmétriques d'applications.

138



• Répertorier des métriques à l’aide de ListMetrics.• Récupérer des alarmes pour une métrique à l’aide de DescribeAlarmsForMetric.• Obtenir des statistiques pour une métrique à l’aide de GetMetricStatistics.



Liste de métriquesImportations



Exemple de code


try { $result = $client->listMetrics(); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Récupérer des alarmes pour une métriqueImportations



Exemple de code

139

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#listmetrics

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#describealarmsformetric

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#getmetricstatistics





try { $result = $client->describeAlarmsForMetric(array( // MetricName is required 'MetricName' => 'ApproximateNumberOfMessagesVisible', // Namespace is required 'Namespace' => 'AWS/SQS', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Obtenir des statistiques de métriquesImportations



Exemple de code


try { $result = $client->getMetricStatistics(array( 'Namespace' => 'string', 'MetricName' => 'CloudWatchTests', //StartTime : mixed type: string (date format)|int (unix timestamp)|\DateTime 'StartTime' => strtotime('-1 days'), //EndTime : mixed type: string (date format)|int (unix timestamp)|\DateTime 'EndTime' => strtotime('now'), //The granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default value is 60 'Period' => 3000, 'Statistics' => array('Maximum', 'Minimum'), )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

140

AWS SDK pour PHP Manuel du développeurPublication de métriques personnalisées

dans Amazon CloudWatch

Publication de métriques personnalisées dansAmazon CloudWatch avec le kit AWS SDK for PHPversion 3Les métriques sont des données sur les performances de vos systèmes. Une alarme surveille une métriquesur la période que vous spécifiez. Elle réalise une ou plusieurs actions en fonction de la valeur de lamétrique, par rapport à un seuil donné sur un certain nombre de périodes.


• Publier des données de métriques à l’aide de PutMetricData.• Créer une alarme à l’aide de PutMetricAlarm.



Publier des données de métriquesImportations



Exemple de code


try { $result = $client->putMetricData(array( 'Namespace' => 'string', 'MetricData' => array( array( 'MetricName' => 'string', //Timestamp : mixed type: string (date format)|int (unix timestamp)|\DateTime 'Timestamp' => time(), 'Value' => integer, 'Unit' => 'Kilobytes' ) ) )); var_dump($result);} catch (AwsException $e) {

141

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#putmetricdata

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#putmetricalarm



AWS SDK pour PHP Manuel du développeurEnvoi d’événements à Amazon CloudWatch Events

// output error message if fails error_log($e->getMessage());}

Créer une alarmeImportations



Exemple de code


try { $result = $client->putMetricAlarm(array( // AlarmName is required 'AlarmName' => 'string', // MetricName is required 'MetricName' => 'string', // Namespace is required 'Namespace' => 'string', // Statistic is required //string: SampleCount | Average | Sum | Minimum | Maximum 'Statistic' => 'string', // Period is required 'Period' => integer, 'Unit' => 'Count/Second', // EvaluationPeriods is required 'EvaluationPeriods' => integer, // Threshold is required 'Threshold' => integer, // ComparisonOperator is required // string: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold 'ComparisonOperator' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Envoi d’événements à Amazon CloudWatch Eventsavec le kit AWS SDK for PHP version 3CloudWatch Events fournit un flux d’événements système en temps quasi-réel décrivant les modificationsapportées aux diverses cibles des ressources Amazon Web Services (AWS). À l'aide de règles simples,

142


vous pouvez faire correspondre les événements et les acheminer vers un ou plusieurs flux ou fonctionscibles.


• Créer une règle à l’aide de PutRule.• Ajouter des cibles à une règle à l’aide de PutTargets.• Envoyer des événements personnalisés à CloudWatch Events à l’aide de PutEvents.



Créer une règleImportations


use Aws\CloudWatchEvents\CloudWatchEventsClient; use Aws\Exception\AwsException;

Exemple de code

$client = new Aws\cloudwatchevents\cloudwatcheventsClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2015-10-07']);

try { $result = $client->putRule(array( 'Name' => 'DEMO_EVENT', // REQUIRED 'RoleArn' => 'IAM_ROLE_ARN', 'ScheduleExpression' => 'rate(5 minutes)', 'State' => 'ENABLED', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Ajouter des cibles à une règleImportations

143

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-events-2015-10-07.html#putrule

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-events-2015-10-07.html#puttargets

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-events-2015-10-07.html#putevents






Exemple de code


try { $result = $client->putTargets([ 'Rule' => 'DEMO_EVENT', // REQUIRED 'Targets' => [ // REQUIRED [ 'Arn' => 'LAMBDA_FUNCTION_ARN', // REQUIRED 'Id' => 'myCloudWatchEventsTarget' // REQUIRED ], ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Envoyer des événements personnalisésImportations



Exemple de code


try { $result = $client->putEvents([ 'Entries' => [ // REQUIRED [ 'Detail' => '<string>', 'DetailType' => '<string>', 'Resources' => ['<string>'], 'Source' => '<string>', 'Time' => time() ], ], ]);

144

AWS SDK pour PHP Manuel du développeurUtilisation d’actions d’alarme avecdes alarmes Amazon CloudWatch

var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation d’actions d’alarme avec les alarmesAmazon CloudWatch avec le kit AWS SDK for PHPversion 3Utilisez des actions d'alarme pour créer des alarmes qui arrêtent, résilient, redémarrent ou récupèrent vosinstances Amazon EC2 automatiquement. Vous pouvez utiliser les actions d'arrêt ou de mise hors servicequand vous n'avez plus besoin qu'une instance s'exécute. Vous pouvez utiliser les actions de redémarrageet de récupération pour redémarrer automatiquement ces instances.


• Activer des actions pour les alarmes spécifiées à l’aide d’EnableAlarmActions.• Désactiver des actions pour les alarmes spécifiées à l’aide de DisableAlarmActions.



Activation d'actions d'alarmeImportations



Exemple de code


try { $result = $client->enableAlarmActions([ 'AlarmNames' => array($alarmName) //REQUIRED ]); var_dump($result);

145

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#enablealarmactions

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-monitoring-2010-08-01.html#disablealarmactions



AWS SDK pour PHP Manuel du développeurExemples Amazon EC2

} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Désactivation d'actions d'alarmeImportations



Exemple de code


try { $result = $client->disableAlarmActions([ 'AlarmNames' => array($alarmName) //REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Exemples Amazon EC2 avec le kit AWS SDK forPHP version 3

Amazon Elastic Compute Cloud (Amazon EC2) est un service web d’hébergement de serveur virtuel dansle cloud. Destiné aux développeurs, il est conçu pour faciliter les opérations de cloud computing à l'échelledu web en offrant une capacité de calcul redimensionnable.

146




Rubriques• Gestion des instances Amazon EC2 avec le kit AWS SDK for PHP version 3 (p. 147)• Utilisation des adresses IP Elastic avec Amazon EC2 avec le kit AWS SDK for PHP version 3 (p. 149)• Utilisation des régions et des zones de disponibilité pour Amazon EC2 avec le kit AWS SDK for PHP

version 3 (p. 151)• Utilisation des paires de clés Amazon EC2 avec le kit AWS SDK for PHP version 3 (p. 153)• Utilisation des groupes de sécurité dans Amazon EC2 avec le kit AWS SDK for PHP

version 3 (p. 155)

Gestion des instances Amazon EC2 avec le kit AWSSDK for PHP version 3Les exemples suivants montrent comment :

• Décrire des instances Amazon EC2 à l’aide de DescribeInstances.• Activer la surveillance détaillée d’une instance en cours d’exécution à l’aide de MonitorInstances.• Désactiver la surveillance d’une instance en cours d’exécution à l’aide d’UnmonitorInstances.• Lancer une AMI basée sur Amazon EBS précédemment arrêtée à l'aide de StartInstances.• Arrêter une instance basée sur Amazon EBS à l’aide de StopInstances.• Demander un redémarrage d’une ou de plusieurs instances à l’aide de RebootInstances.



Description d'instancesImportations



147



https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#describeinstances

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#monitorinstances

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#unmonitorinstances

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#startinstances

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#stopinstances

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#rebootinstances



AWS SDK pour PHP Manuel du développeurGestion des instances Amazon EC2

Exemple de code

$ec2Client = new Aws\Ec2\Ec2Client([ 'region' => 'us-west-2', 'version' => '2016-11-15', 'profile' => 'default']);

$result = $ec2Client->describeInstances();

var_dump($result);

Activer et désactiver la surveillanceImportations



Exemple de code


$instanceIds = array('InstanceID1', 'InstanceID2');

$monitorInstance = 'ON';

if ($monitorInstance == 'ON') { $result = $ec2Client->monitorInstances(array( 'InstanceIds' => $instanceIds ));} else { $result = $ec2Client->unmonitorInstances(array( 'InstanceIds' => $instanceIds ));}

var_dump($result);

Lancer et arrêter une instanceImportations



Exemple de code

148

AWS SDK pour PHP Manuel du développeurUtilisation des adresses IP Elastic


$action = 'START';


if ($action == 'START') { $result = $ec2Client->startInstances(array( 'InstanceIds' => $instanceIds, ));} else { $result = $ec2Client->stopInstances(array( 'InstanceIds' => $instanceIds, ));}

var_dump($result);

Redémarrer une instanceImportations



Exemple de code



$result = $ec2Client->rebootInstances(array( 'InstanceIds' => $instanceIds));

var_dump($result);

Utilisation des adresses IP Elastic avec Amazon EC2avec le kit AWS SDK for PHP version 3Une EIP est une adresse IP statique conçue pour le cloud computing. Une adresse IP Elastic est associéeà votre compte AWS. Il s'agit d'une adresse IP publique accessible depuis Internet. Si votre instance nedispose pas d'une adresse IP publique, vous pouvez lui associer une adresse IP Elastic pour établir lacommunication avec Internet.

149

AWS SDK pour PHP Manuel du développeurUtilisation des adresses IP Elastic


• Décrire une ou plusieurs de vos instances à l’aide de DescribeInstances.• Acquérir une adresse IP Elastic à l’aide d’AllocateAddress• Associer une adresse IP Elastic à une instance à l’aide d’AssociateAddress.• Libérer une adresse IP Elastic à l’aide de ReleaseAddress.



Décrire une instanceImportations



Exemple de code


$result = $ec2Client->describeInstances();

var_dump($result);

Allouer et associer une adresseImportations



Exemple de code

$ec2Client = new Aws\Ec2\Ec2Client([ 'region' => 'us-west-2', 'version' => '2016-11-15', 'profile' => 'default'

150

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#describeinstances

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#allocateaddress

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#associateaddress

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#releaseaddress



AWS SDK pour PHP Manuel du développeurUtilisation des régions et des zones de disponibilité

]);

$instanceId = 'InstanceID';

$allocation = $ec2Client->allocateAddress(array( 'DryRun' => false, 'Domain' => 'vpc',));

$result = $ec2Client->associateAddress(array( 'DryRun' => false, 'InstanceId' => $instanceId, 'AllocationId' => $allocation->get('AllocationId')));

var_dump($result);

Libérer une adresseImportations



Exemple de code


$associationID = 'AssociationID';

$allocationID = 'AllocationID';

$result = $ec2Client->disassociateAddress(array( 'AssociationId' => $associationID,));

$result = $ec2Client->releaseAddress(array( 'AllocationId' => $allocationID,));

var_dump($result);

Utilisation des régions et des zones de disponibilitépour Amazon EC2 avec le kit AWS SDK for PHPversion 3Amazon EC2 est hébergé à plusieurs endroits dans le monde. Ces emplacements sont composés derégions AWS et de zones de disponibilité. Chaque région est une zone géographique distincte renfermant

151

AWS SDK pour PHP Manuel du développeurUtilisation des régions et des zones de disponibilité

plusieurs emplacements isolés appelés zones de disponibilité. Amazon EC2 vous offre la possibilité deplacer des instances et des données dans plusieurs emplacements.


• Décrire les zones de disponibilité disponibles pour votre compte à l’aide de DescribeAvailabilityZones.• Décrire les régions AWS actuellement disponibles pour votre compte à l’aide de DescribeRegions.



Décrire les zones de disponibilitéImportations



Exemple de code


$result = $ec2Client->describeAvailabilityZones();

var_dump($result);

Décrire des régionsImportations



Exemple de code

$ec2Client = new Aws\Ec2\Ec2Client([ 'region' => 'us-west-2', 'version' => '2016-11-15', 'profile' => 'default'

152

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#describeavailabilityzones

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#describeregions



AWS SDK pour PHP Manuel du développeurUtilisation des paires de clés

]);

$result = $ec2Client->describeRegions();

var_dump($result);

Utilisation des paires de clés Amazon EC2 avec le kitAWS SDK for PHP version 3Amazon EC2 utilise le chiffrement de clé publique pour chiffrer et déchiffrer les informations de connexion.Le chiffrement de clé publique utilise une clé publique pour chiffrer les données. Ensuite, le destinataireutilise la clé privée pour déchiffrer les données. La clé publique et la clé privée constituent une paire declés.


• Créer une paire de clés RSA 2048 bits en utilisant CreateKeyPair.• Supprimer une paire de clés à l’aide de DeleteKeyPair.• Décrire une ou plusieurs paires de clés à l’aide de DescribeKeyPairs.



Créer une paire de clésImportations



Exemple de code


$keyPairName = 'my-keypair';

$result = $ec2Client->createKeyPair(array( 'KeyName' => $keyPairName));

153

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#createkeypair

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#deletekeypair

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#describekeypairs



AWS SDK pour PHP Manuel du développeurUtilisation des paires de clés

// Save the private key$saveKeyLocation = getenv('HOME') . "/.ssh/{$keyPairName}.pem";file_put_contents($saveKeyLocation, $result['keyMaterial']);

// Update the key's permissions so it can be used with SSHchmod($saveKeyLocation, 0600);

Suppression d'une paire de clésImportations



Exemple de code


$keyPairName = 'my-keypair';

$result = $ec2Client->deleteKeyPair(array( 'KeyName' => $keyPairName));

var_dump($result);

Description de paires de clésImportations



Exemple de code


$result = $ec2Client->describeKeyPairs();

var_dump($result);

154

AWS SDK pour PHP Manuel du développeurUtilisation des groupes de sécurité

Utilisation des groupes de sécurité dans Amazon EC2avec le kit AWS SDK for PHP version 3Un groupe de sécurité Amazon EC2 fonctionne comme un pare-feu virtuel qui contrôle le trafic d'une ouplusieurs instances. Vous ajoutez des règles à chaque groupe de sécurité pour autoriser le trafic vers oudepuis ses instances associées. Vous pouvez modifier les règles pour un groupe de sécurité à la fois. Lesnouvelles règles sont automatiquement appliquées à toutes les instances associées au groupe de sécurité.


• Décrire un ou plusieurs de vos groupes de sécurité à l’aide de DescribeSecurityGroups.• Ajouter une règle d’entrée à un groupe de sécurité à l’aide d’AuthorizeSecurityGroupIngress.• Créer un groupe de sécurité à l’aide de CreateSecurityGroup.• Supprimer un groupe de sécurité à l’aide de DeleteSecurityGroup.



Description des groupes de sécuritéImportations



Exemple de code


$result = $ec2Client->describeSecurityGroups();

var_dump($result);

Ajout d'une règle d'entréeImportations

155

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#describesecuritygroups

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#authorizesecuritygroupingress

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#createsecuritygroup

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-ec2-2016-11-15.html#deletesecuritygroup



AWS SDK pour PHP Manuel du développeurUtilisation des groupes de sécurité



Exemple de code


$result = $ec2Client->authorizeSecurityGroupIngress(array( 'GroupName' => 'string', 'SourceSecurityGroupName' => 'string'));

var_dump($result);

Créer un groupe de sécuritéImportations



Exemple de code


// Create the security group$securityGroupName = 'my-security-group';$result = $ec2Client->createSecurityGroup(array( 'GroupId' => $securityGroupName,

));

// Get the security group ID (optional)$securityGroupId = $result->get('GroupId');

echo "Security Group ID: " . $securityGroupId . '\n';

Supprimer un groupe de sécuritéImportations


156

AWS SDK pour PHP Manuel du développeurAmazon Elasticsearch


Exemple de code


$securityGroupId = 'my-security-group-id';

$result = $ec2Client->deleteSecurityGroup(array( 'GroupId' => $securityGroupId));

var_dump($result);

Signature d’une demande de recherche AmazonElasticsearch Service avec le kit AWS SDK for PHPversion 3

Amazon Elasticsearch Service (Amazon ES) est un service géré qui facilite le déploiement, l'utilisation etle dimensionnement d'Amazon Elasticsearch Service, un moteur d'analyse et de recherche open sourcecouramment utilisé. Amazon ES offre un accès direct à l'API Amazon Elasticsearch Service. Cela signifieque les développeurs peuvent utiliser les outils qu'ils connaissent, ainsi que des options de sécurité fiables,comme le recours à des utilisateurs et des rôles IAM pour le contrôle de l'accès. De nombreux clientsAmazon Elasticsearch Service prennent en charge la signature de demande, mais si vous utilisez un clientqui ne le fait pas, vous pouvez signer des demandes PSR-7 arbitraires avec les fournisseurs d'informationsd'identification intégrés et les utilisateurs de AWS SDK for PHP.


• Signer une demande avec le protocole de signature AWS en utilisant SignatureV4.



Signature d'une demande Amazon ESAmazon ES utilise Signature Version 4. Cela signifie que vous devez signer des demandes sur la signaturedu service (es, dans le cas présent) et la région AWS du domaine Amazon ES. La liste complète desrégions prises en charge par Amazon ES est disponible sur la page régions et points de terminaison

157

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Signature.SignatureV4.html#_signRequest





AWS SDK pour PHP Manuel du développeurExemples AWS Identity and Access Management (IAM)

AWS dans le Amazon Web Services General Reference. Cependant, dans cet exemple, nous signons lesdemandes adressées à un domaine Amazon ES dans la région us-west-2.

Vous devrez fournir les informations d'identification, ce que vous pouvez faire avec la chaîne defournisseur par défaut du kit SDK ou avec toutes les formes d'informations d'identification décrites dans lesInformations d'identification pour le kit AWS SDK pour PHP version 3 (p. 42). Vous aurez également besoind'une demande PSR-7 (censée s'appeler $psr7Request dans le code ci-dessous).

// Pull credentials from the default provider chain$provider = Aws\Credentials\CredentialProvider::defaultProvider();$credentials = call_user_func($provider)->wait();

// Create a signer with the service's signing name and Region$signer = new Aws\Signature\SignatureV4('es', 'us-west-2');

// Sign your request$signedRequest = $signer->signRequest($psr7Request, $credentials);

Exemples AWS IAM avec le kit AWS SDK for PHPversion 3

AWS Identity and Access Management (IAM) est un service web qui permet aux clients Amazon WebServices (AWS) de gérer les utilisateurs et les autorisations utilisateur dans AWS. Ce service est destinéaux organisations dotées de plusieurs utilisateurs ou systèmes dans le cloud qui utilisent les produitsAWS. Avec IAM, vous pouvez gérer de façon centralisée les utilisateurs, les informations d'identification desécurité comme les clés d'accès et les autorisations qui déterminent les ressources AWS auxquelles lesutilisateurs peuvent accéder.



Rubriques• Gestion des clés d’accès IAM avec le kit AWS SDK for PHP version 3 (p. 159)• Gestion des utilisateurs IAM avec le kit AWS SDK for PHP version 3 (p. 162)

158


https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Psr.Http.Message.RequestInterface.html



AWS SDK pour PHP Manuel du développeurGestion des clés d’accès IAM

• Utilisation des alias de compte IAM avec le kit AWS SDK for PHP version 3 (p. 165)• Utilisation des stratégies IAM avec le kit AWS SDK for PHP version 3 (p. 167)• Utilisation des certificats de serveur IAM avec le kit AWS SDK for PHP version 3 (p. 174)

Gestion des clés d’accès IAM avec le kit AWS SDK forPHP version 3Les utilisateurs ont besoin de leurs propres clés d'accès pour effectuer des appels par programmation versAWS. Pour répondre à cette attente, vous pouvez créer, modifier, afficher ou faire tourner les clés d'accès(ID de clés d'accès et clés d'accès secrètes) pour les utilisateurs IAM. Par défaut, lorsque vous créez uneclé d'accès, son état est Active. Cela signifie que l'utilisateur peut se servir de la clé d'accès pour effectuerdes appels d'API.


• Créer une clé d’accès secrète et l’ID de clé d’accès correspondant à l’aide de CreateAccessKey.• Renvoyer des informations sur les ID de clé d’accès associés à un utilisateur IAM à l’aide de

ListAccessKeys.• Récupérer des informations sur la dernière utilisation d’une clé d’accès à l’aide de

GetAccessKeyLastUsed.• Modifier l’état d’une clé d’accès de Active à Inactive, ou inversement, à l’aide de UpdateAccessKey.• Supprimer une paire de clés d’accès associée à un utilisateur IAM à l’aide de DeleteAccessKey.



Créer une clé d'accèsImportations



Exemple de code


try {

159

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createaccesskey

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listaccesskeys

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getaccesskeylastused

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateaccesskey

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteaccesskey




$result = $client->createAccessKey([ 'UserName' => 'IAM_USER_NAME', ]); $keyID = $result['AccessKey']['AccessKeyId']; $createDate = $result['AccessKey']['CreateDate']; $userName = $result['AccessKey']['UserName']; $status = $result['AccessKey']['Status']; // $secretKey = $result['AccessKey']['SecretAccessKey'] echo "<p>AccessKey " . $keyID . " created on " . $createDate . "</p>"; echo "<p>Username: " . $userName . "</p>"; echo "<p>Status: " . $status . "</p>";} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Répertorier des clés d'accèsImportations



Exemple de code


try { $result = $client->listAccessKeys(); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Obtenir des informations sur la dernière utilisation d'une cléd'accèsImportations



Exemple de code

160



try { $result = $client->getAccessKeyLastUsed([ 'AccessKeyId' => 'ACCESS_KEY_ID', // REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Mettre à jour une clé d'accèsImportations



Exemple de code


try { $result = $client->updateAccessKey([ 'AccessKeyId' => 'ACCESS_KEY_ID', // REQUIRED 'Status' => 'Inactive', // REQUIRED 'UserName' => 'IAM_USER_NAME', ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Suppression d'une clé d'accèsImportations



161

AWS SDK pour PHP Manuel du développeurGestion des utilisateurs IAM

Exemple de code


try { $result = $client->deleteAccessKey([ 'AccessKeyId' => 'ACCESS_KEY_ID', // REQUIRED 'UserName' => 'IAM_USER_NAME', ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Gestion des utilisateurs IAM avec le kit AWS SDK forPHP version 3Un utilisateur IAM est une entité que vous créez dans AWS pour représenter la personne ou le servicequi l'utilise pour interagir avec AWS. Dans AWS, un utilisateur se compose d'un nom et d'informationsd'identification.


• Créer un nouvel utilisateur IAM à l’aide de CreateUser.• Répertorier les utilisateurs IAM à l’aide de ListUsers.• Mettre à jour un utilisateur IAM à l’aide de UpdateUser.• Récupérer des informations sur un utilisateur IAM à l’aide de GetUser.• Supprimer un utilisateur IAM à l’aide de DeleteUser.



Créer un utilisateur IAMImportations



162

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#createuser

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#listusers

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#updateuser

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#getuser

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#deleteuser




Exemple de code


try { $result = $client->createUser(array( // UserName is required 'UserName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Répertorier des utilisateurs IAMImportations



Exemple de code


try { $result = $client->listUsers(); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Mettre à jour un utilisateur IAMImportations



163


Exemple de code


try { $result = $client->updateUser(array( // UserName is required 'UserName' => 'string1', 'NewUserName' => 'string' )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Obtenir des informations sur un utilisateur IAMImportations



Exemple de code


try { $result = $client->getUser(array( 'UserName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Supprimer un utilisateur IAMImportations



164

AWS SDK pour PHP Manuel du développeurUtilisation des alias de compte IAM


Exemple de code


try { $result = $client->deleteUser(array( // UserName is required 'UserName' => 'string' )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation des alias de compte IAM avec le kit AWSSDK for PHP version 3Si vous voulez que l'URL de votre page de connexion contienne le nom de votre entreprise ou tout autreidentifiant convivial au lieu de votre ID de compte AWS, vous pouvez créer un alias pour ce dernier. Sivous créez un alias de compte AWS, l'URL de votre page de connexion est modifiée de manière à intégrerl'alias.


• Créer un alias à l’aide de CreateAccountAlias.• Répertorier les alias associés au compte AWS à l’aide de ListAccountAliases.• Supprimer un alias à l’aide de DeleteAccountAlias.



Création d'un aliasImportations



165

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#createaccountalias

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#listaccountaliases

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-iam-2010-05-08.html#deleteaccountalias



AWS SDK pour PHP Manuel du développeurUtilisation des alias de compte IAM


Exemple de code


try { $result = $client->createAccountAlias(array( // AccountAlias is required 'AccountAlias' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Lister des alias de compteImportations



Exemple de code


try { $result = $client->listAccountAliases(); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Suppression d'un aliasImportations



166

AWS SDK pour PHP Manuel du développeurUtilisation des stratégies IAM


Exemple de code


try { $result = $client->deleteAccountAlias(array( // AccountAlias is required 'AccountAlias' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation des stratégies IAM avec le kit AWS SDK forPHP version 3Vous devez accorder des autorisations à un utilisateur en créant une stratégie. Une stratégie est undocument qui répertorie les actions qu'un utilisateur peut effectuer ainsi que les ressources que ces actionspeuvent affecter. Les actions ou ressources qui ne sont pas explicitement autorisées sont refusées pardéfaut. Vous pouvez créer des stratégies et les attacher à des utilisateurs, à des groupes d'utilisateurs, àdes rôles pris en charge par des utilisateurs et à des ressources.


• Créer une stratégie gérée à l’aide de CreatePolicy.• Attacher une stratégie à un rôle à l’aide d’AttachRolePolicy.• Attacher une stratégie à un utilisateur à l’aide d’AttachUserPolicy.• Attacher une stratégie à un groupe à l'aide d'AttachGroupPolicy.• Retirer une stratégie de rôle à l'aide de DetachRolePolicy.• Supprimer une stratégie utilisateur à l’aide de DetachUserPolicy.• Retirer une stratégie de groupe à l'aide de DetachGroupPolicy.• Supprimer une stratégie gérée à l'aide de DeletePolicy.• Supprimer une stratégie de rôle à l'aide de DeleteRolePolicy.• Supprimer une stratégie utilisateur à l'aide de DeleteUserPolicy.• Supprimer une stratégie de groupe à l'aide de DeleteGroupPolicy.



167

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createpolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachrolepolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachuserpolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachgrouppolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachrolepolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachuserpolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachgrouppolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deletepolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleterolepolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteuserpolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deletegrouppolicy





Créer une stratégieImportations



Exemple de code


$myManagedPolicy = '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "logs:CreateLogGroup", "Resource": "RESOURCE_ARN" }, { "Effect": "Allow", "Action": [ "dynamodb:DeleteItem", "dynamodb:GetItem", "dynamodb:PutItem", "dynamodb:Scan", "dynamodb:UpdateItem" ], "Resource": "RESOURCE_ARN" } ]}';

try { $result = $client->createPolicy(array( // PolicyName is required 'PolicyName' => 'myDynamoDBPolicy', // PolicyDocument is required 'PolicyDocument' => $myManagedPolicy )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Attacher une stratégie à un rôleImportations

168




Exemple de code


$roleName = 'ROLE_NAME';

$policyName = 'AmazonDynamoDBFullAccess';

$policyArn = 'arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess';

try { $attachedRolePolicies = $client->getIterator('ListAttachedRolePolicies', ([ 'RoleName' => $roleName, ])); if (count($attachedRolePolicies) > 0) { foreach ($attachedRolePolicies as $attachedRolePolicy) { if ($attachedRolePolicy['PolicyName'] == $policyName) { echo $policyName . " is already attached to this role. \n"; exit(); } } } $result = $client->attachRolePolicy(array( // RoleName is required 'RoleName' => $roleName, // PolicyArn is required 'PolicyArn' => $policyArn )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Attacher une stratégie à un utilisateurImportations



Exemple de code

$client = new IamClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2010-05-08'

169


]);

$userName = 'USER_NAME';

$policyName = 'AmazonDynamoDBFullAccess';

$policyArn = 'arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess';

try { $attachedUserPolicies = $client->getIterator('ListAttachedUserPolicies', ([ 'UserName' => $userName, ])); if (count($attachedUserPolicies) > 0) { foreach ($attachedUserPolicies as $attachedUserPolicy) { if ($attachedUserPolicy['PolicyName'] == $policyName) { echo $policyName . " is already attached to this role. \n"; exit(); } } } $result = $client->attachUserPolicy(array( // UserName is required 'UserName' => $userName, // PolicyArn is required 'PolicyArn' => $policyArn, )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Attacher une stratégie à un groupeImportations



Exemple de code


try { $result = $client->attachGroupPolicy(array( // GroupName is required 'GroupName' => 'string', // PolicyArn is required 'PolicyArn' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());

170


}

Détacher une stratégie utilisateurImportations



Exemple de code


try { $result = $client->detachUserPolicy(array( // UserName is required 'UserName' => 'string', // PolicyArn is required 'PolicyArn' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Détacher une stratégie de groupeImportations



Exemple de code


try { $result = $client->detachGroupPolicy(array( // GroupName is required 'GroupName' => 'string',

171


// PolicyArn is required 'PolicyArn' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Supprimer une stratégieImportations



Exemple de code


try { $result = $client->deletePolicy(array( // PolicyArn is required 'PolicyArn' => 'string' )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Supprimer une stratégie de rôleImportations



Exemple de code


172


try { $result = $client->deleteRolePolicy(array( // RoleName is required 'RoleName' => 'string', // PolicyName is required 'PolicyName' => 'string' )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Supprimer une stratégie utilisateurImportations



Exemple de code


try { $result = $client->deleteUserPolicy(array( // UserName is required 'UserName' => 'string', // PolicyName is required 'PolicyName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Supprimer une stratégie de groupeImportations



Exemple de code

173

AWS SDK pour PHP Manuel du développeurUtilisation des certificats de serveur IAM


try { $result = $client->deleteGroupPolicy(array( // GroupName is required 'GroupName' => 'string', // PolicyName is required 'PolicyName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation des certificats de serveur IAM avec le kitAWS SDK for PHP version 3Pour autoriser les connexions HTTPS vers votre site Web ou votre application sur AWS, vous avez besoind'un certificat de serveur SSL/TLS. Pour utiliser un certificat que vous avez obtenu auprès d’un fournisseurexterne avec votre site Web ou votre application sur AWS, vous devez charger le certificat sur IAM oul’importer dans AWS Certificate Manager.


• Répertorier les certificats stockés dans IAM à l’aide de ListServerCertificates.• Récupérer des informations sur un certificat à l’aide de GetServerCertificate.• Mettre à jour un certificat à l’aide de UpdateServerCertificate.• Supprimer un certificat à l’aide de DeleteServerCertificate.



Répertorier les certificats de serveurImportations



174

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listservercertificates

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getservercertificate

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateservercertificate

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteservercertificate



AWS SDK pour PHP Manuel du développeurUtilisation des certificats de serveur IAM

Exemple de code


try { $result = $client->listServerCertificates(); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Récupérer un certificat de serveurImportations



Exemple de code


try { $result = $client->getServerCertificate(array( // ServerCertificateName is required 'ServerCertificateName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Mise à jour d'un certificat de serveurImportations



Exemple de code

175

AWS SDK pour PHP Manuel du développeurAWS Key Management Service


try { $result = $client->updateServerCertificate(array( // ServerCertificateName is required 'ServerCertificateName' => 'string', 'NewServerCertificateName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Suppression d'un certificat de serveurImportations



Exemple de code


try { $result = $client->deleteServerCertificate(array( // ServerCertificateName is required 'ServerCertificateName' => 'string', )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Exemples AWS Key Management Service utilisantle kit AWS SDK for PHP version 3

AWS Key Management Service (AWS KMS) est un service géré qui facilite la création et le contrôle desclés de chiffrement utilisées pour chiffrer vos données. Pour plus d’informations sur AWS KMS, consultez

176

AWS SDK pour PHP Manuel du développeurUtilisation de clés

la documentation Amazon KMS. Que vous écriviez des applications PHP sécurisées ou que vous envoyiezdes données à d’autres services AWS, AWS KMS vous permet de contrôler qui peut utiliser vos clésprincipales et accéder à vos données chiffrées.


Rubriques• Utilisation des clés à l’aide de l’API AWS KMS et du kit AWS SDK for PHP version 3 (p. 177)• Chiffrement et déchiffrement des clés de données AWS KMS à l’aide du kit AWS SDK for PHP

version 3 (p. 181)• Utilisation des stratégies de clés AWS KMS à l’aide du kit AWS SDK for PHP version 3 (p. 184)• Utilisation des octrois à l’aide de l’API AWS KMS et du kit AWS SDK for PHP version 3 (p. 187)• Utilisation des alias à l’aide de l’API AWS KMS et du kit AWS SDK for PHP version 3 (p. 190)

Utilisation des clés à l’aide de l’API AWS KMS et du kitAWS SDK for PHP version 3Les ressources principales dans AWS Key Management Service (AWS KMS) sont les clés principalesclient (clés CMK). Vous pouvez utiliser une clé CMK pour chiffrer vos données.


• Créez une clé CMK client à l’aide de CreateKey.• Générer une clé de données à l’aide de GenerateDataKey.• Afficher une clé CMK à l’aide de DescribeKey.• Obtenir des ID de clé et des ARNS de clés CMK à l’aide de ListKeys.• Activer les clés CMK à l’aide de EnableKey.• Désactiver les clés CMK à l’aide de DisableKey.



177

https://aws.amazon.com/documentation/kms/



https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys.html


https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#createkey

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#generatedatakey

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#describekey

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listkeys

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#enablekey

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#disablekey




Pour plus d’informations sur l’utilisation de AWS Key Management Service (AWS KMS), consultez lemanuel du développeur AWS KMS.

Créez une clé CMKPour créer une clé CMK, utilisez l’opération CreateKey.

Importations


use Aws\Kms\KmsClient; use Aws\Exception\AwsException;

Exemple de code

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2']);

//Creates a customer master key (CMK) in the caller's AWS account.$desc = "Key for protecting critical data";

try { $result = $KmsClient->createKey([ 'Description' => $desc, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Générer une clé de donnéesPour générer une clé de chiffrement, utilisez l’opération GenerateDataKey. Cette opération renvoie descopies en texte brut et chiffrées de la clé de données créée. Spécifiez la clé principale client (CMK) danslaquelle générer la clé de données.

Importations



Exemple de code

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2'

178

https://docs.aws.amazon.com/kms/latest/developerguide/


https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html


]);

$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$keySpec = 'AES_256';

try { $result = $KmsClient->generateDataKey([ 'KeyId' => $keyId, 'KeySpec' => $keySpec, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Afficher une clé CMKPour obtenir des informations détaillées sur clé principale personnalisée (clé CMK), y compris son AmazonResource Name (ARN) et son état de clé, utilisez l'opération DescribeKey.

DescribeKey ne récupère pas les alias. Pour obtenir des alias, utilisez l’opération ListAliases.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';

try { $result = $KmsClient->describeKey([ 'KeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Obtenez l’ID de clé et les ARN de clé d’une clé CMKPour obtenir l’ID et l’ARN d’une clé CMK, utilisez l’opération ListAliases.

179

https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html


Importations



Exemple de code


$limit = 10;

try { $result = $KmsClient->listKeys([ 'Limit' => $limit, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Activer une clé CMKPour activer une clé CMK désactivée, utilisez l’opération EnableKey.

Importations



Exemple de code



try { $result = $KmsClient->enableKey([ 'KeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) {

180

https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html

AWS SDK pour PHP Manuel du développeurChiffrement et déchiffrement des clés de données

// output error message if fails echo $e->getMessage(); echo "\n";}

Désactiver une clé CMKPour désactiver une clé CMK, utilisez l’opération DisableKey. Désactiver une clé CMK empêche celle-cid'être utilisée.

Importations



Exemple de code



try { $result = $KmsClient->disableKey([ 'KeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Chiffrement et déchiffrement des clés de donnéesAWS KMS à l’aide du kit AWS SDK for PHP version 3Les clés de données sont des clés de chiffrement que vous pouvez utiliser pour chiffrer des données, ycompris de grandes quantités de données et d’autres clés de chiffrement des données.

Vous pouvez une clé principale client AWS Key Management Service (AWS KMS) pour générer, chiffrer etdéchiffrer les clés de données. Toutefois, AWS KMS ne stocke pas, ne gère pas et ne suit pas vos clés dedonnées, et il n'effectue pas non plus d'opérations cryptographiques avec les clés de données. Utilisez etgérez les clés de données en dehors d'AWS KMS.


• Chiffrer une clé de données à l’aide d’Encrypt.• Déchiffrer une clé de données à l’aide de Decrypt.

181

https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html


https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#encrypt

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#decrypt


• Rechiffrer une clé de données avec une nouvelle clé CMK à l’aide de ReEncrypt.




EncryptL'opération Encrypt est conçue pour chiffrer des clés de données, mais elle n'est pas fréquemment utilisée.Les opérations GenerateDataKey et GenerateDataKeyWithoutPlaintext renvoient des clés de donnéeschiffrées. Vous pouvez utiliser la méthode Encypt lorsque vous déplacez des données chiffrées vers unenouvelle région AWS et que vous souhaitez chiffrer leur clé de données à l'aide d'une clé CMK dans lanouvelle région.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$message = pack('c*', 1, 2, 3, 4, 5, 6, 7, 8, 9, 0);

try { $result = $KmsClient->encrypt([ 'KeyId' => $keyId, 'Plaintext' => $message, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

DecryptPour déchiffrer une clé de données, utilisez l’opération Decrypt.

182

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#reencrypt




https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html


https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html


Le ciphertextBlob que vous spécifiez doit correspondre à la valeur du champ CiphertextBlobprovenant d’une réponse GenerateDataKey, GenerateDataKeyWithoutPlaintext ou Encrypt.

Importations



Exemple de code


$ciphertext = 'Place your cipher text blob here';

try { $result = $KmsClient->decrypt([ 'CiphertextBlob' => $ciphertext, ]); $plaintext = $result['Plaintext']; var_dump($plaintext);} catch (AwsException $e) { // Output error message if fails echo $e->getMessage(); echo "\n";}

RechiffrerPour déchiffrer une clé de données chiffrée, puis la rechiffrer immédiatement sous une nouvelle clé CMK,utilisez l’opération ReEncrypt. Les opérations sont effectuées entièrement côté serveur dans AWS KMS,pour que votre texte brut ne soit jamais exposé en dehors d'AWS KMS.

Le ciphertextBlob que vous spécifiez doit correspondre à la valeur du champ CiphertextBlobprovenant d’une réponse GenerateDataKey, GenerateDataKeyWithoutPlaintext ou Encrypt.

Importations



Exemple de code


183




https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html




AWS SDK pour PHP Manuel du développeurUtilisation de stratégies de clé

$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$ciphertextBlob = 'Place your cipher text blob here';

try { $result = $KmsClient->reEncrypt([ 'CiphertextBlob' => $ciphertextBlob, 'DestinationKeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Utilisation des stratégies de clés AWS KMS à l’aide dukit AWS SDK for PHP version 3Lorsque vous créez une clé AWS Key Management Service (AWS KMS), vous déterminez qui peut utiliseret gérer cette clé CMK. Ces autorisations sont contenues dans un document appelé stratégie de clé. Vouspouvez utiliser la stratégie de clé pour ajouter, supprimer ou modifier des autorisations, à tout moment,pour une clé CMK gérée par le client, mais vous ne pouvez pas modifier la stratégie de clé pour une cléCMK gérée par AWS. Pour plus d’informations, consultez la section Authentification et contrôle d’accèspour AWS KMS.


• Répertorier les noms des stratégies de clés à l’aide de ListKeyPolicies.• Obtenir une stratégie de clé à l’aide de GetKeyPolicy.• Définir une stratégie de clé à l’aide de PutKeyPolicy.




Répertorie toutes les stratégies de clésPour obtenir les noms des stratégies de clé pour une clé CMK, utilisez l’opération ListKeyPolicies. Leseul nom de stratégie de clé renvoyé est le nom par défaut.

Importations


184


https://docs.aws.amazon.com/kms/latest/developerguide/control-access.html

https://docs.aws.amazon.com/kms/latest/developerguide/control-access.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listkeypolicies

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#getkeypolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#putkeypolicy






Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$limit = 10;

try { $result = $KmsClient->listKeyPolicies([ 'KeyId' => $keyId, 'Limit' => $limit, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Récupérer une stratégie de cléPour obtenir la stratégie de clé pour une clé CMK, utilisez l’opération GetKeyPolicy.

GetKeyPolicy nécessite un nom de stratégie. Si vous n’avez pas créé de stratégie de clé lors de lacréation de la clé CMK, le seul nom de stratégie valide est celui par défaut. Découvrez-en davantage sur lastratégie de clé par défaut.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$policyName = "default";

try { $result = $KmsClient->getKeyPolicy([ 'KeyId' => $keyId,

185

https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default.html


'PolicyName' => $policyName ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Définir une stratégie de cléPour établir ou modifier une stratégie de clé pour une clé CMK, utilisez l’opération PutKeyPolicy.

PutKeyPolicy nécessite un nom de stratégie. Si vous n’avez pas créé de stratégie de clé lors de lacréation de la clé CMK, le seul nom de stratégie valide est celui par défaut. Découvrez-en davantage plussur la stratégie de clé par défaut.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$policyName = "default";

try { $result = $KmsClient->putKeyPolicy([ 'KeyId' => $keyId, 'PolicyName' => $policyName, 'Policy' => '{ "Version": "2012-10-17", "Id": "custom-policy-2016-12-07", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/root" }, "Action": [ "kms:*" ], "Resource": "*" }, { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/ExampleUser" }, "Action": [ "kms:Encrypt*", "kms:GenerateDataKey*", "kms:Decrypt*", "kms:DescribeKey*", "kms:ReEncrypt*"

186

https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default.html

AWS SDK pour PHP Manuel du développeurUtilisation d'octrois

], "Resource": "*" } ] } ' ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Utilisation des octrois à l’aide de l’API AWS KMS et dukit AWS SDK for PHP version 3Un octroi est un autre mécanisme visant à fournir des autorisations, qui fait office d’alternative à la stratégiede clé. Vous pouvez utiliser des octrois pour accorder un accès à long terme permettant à des mandatairesAWS d’utiliser vos clés CMK gérées par le client d’AWS Key Management Service (AWS KMS). Pour plusd’informations, consultez la section Utilisation des octrois.


• Créer un octroi pour une clé principale client (CMK) à l’aide de CreateGrant.• Afficher un octroi pour une clé CMK à l’aide de ListGrants.• Résilier un octroi pour une clé CMK à l’aide de RetireGrant.• Révoquer un octroi pour une clé CMK à l’aide de RevokeGrant.




Créer un octroiPour créer un octroi pour une clé CMK AWS KMS, utilisez l’opération CreateGrant.

Importations



Exemple de code

187


https://docs.aws.amazon.com/kms/latest/developerguide/grants.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#creategrant

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listgrants

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#retiregrant

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#revokegrant




https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html



$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$granteePrincipal = "arn:aws:iam::111122223333:user/Alice";$operation = ['Encrypt', 'Decrypt']; // A list of operations that the grant allows.

try { $result = $KmsClient->createGrant([ 'GranteePrincipal' => $granteePrincipal, 'KeyId' => $keyId, 'Operations' => $operation ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Afficher un octroiPour obtenir des informations détaillées concernant les octrois sur une clé CMK AWS KMS, utilisezl’opération ListGrants.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$limit = 10;

try { $result = $KmsClient->listGrants([ 'KeyId' => $keyId, 'Limit' => $limit, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

188

https://docs.aws.amazon.com/kms/latest/APIReference/API_ListGrants.html


Abandonner un octroiPour résilier un octroi pour une clé CMK AWS KMS, utilisez l’opération RetireGrant. Résilier un octroi pournettoyer une fois que vous avez fini de l'utiliser.

Importations



Exemple de code


$grantToken = 'Place your grant token here';

try { $result = $KmsClient->retireGrant([ 'GrantToken' => $grantToken, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

//Can also identify grant to retire by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK)$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$grantId = 'Unique identifier of the grant returned during CreateGrant operation'

try { $result = $KmsClient->retireGrant([ 'GrantId' => $grantToken, 'KeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Révoquer un octroiPour révoquer un octroi sur une clé CMK AWS KMS, utilisez l’opération RevokeGrant. Vous pouvezrévoquer un octroi pour refuser explicitement les opérations qui en dépendent.

189

https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html

AWS SDK pour PHP Manuel du développeurUtilisation des alias

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$grantId = "grant1";

try { $result = $KmsClient->revokeGrant([ 'KeyId' => $keyId, 'GrantId' => $grantId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Utilisation des alias à l’aide de l’API AWS KMS et dukit AWS SDK for PHP version 3Un alias est un nom d’affichage facultatif pour une clé principale client (CMK) AWS Key ManagementService (AWS KMS).


• Créer un alias à l’aide de CreateAlias.• Afficher un alias à l’aide de ListAliases.• Mettre à jour un alias à l’aide de UpdateAlias.• Supprimer un alias à l’aide de DeleteAlias.



190


https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#createalias

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listaliases

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#updatealias

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#deletealias





Création d'un aliasPour créer un alias pour une clé CMK, utilisez l’opération CreateAlias. L’alias doit être unique dansle compte et la région AWS. Si vous créez un alias pour une clé CMK qui possède déjà un alias,CreateAlias crée un autre alias pour la même clé CMK. Cette opération ne remplace pas l'alias existant.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$aliasName = "alias/projectKey1";

try { $result = $KmsClient->createAlias([ 'AliasName' => $aliasName, 'TargetKeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Afficher un aliasPour répertorier tous les alias, utilisez l’opération ListAliases. La réponse inclut les alias qui sont définis parles services AWS, mais qui ne sont pas associés à une clé CMK.

Importations



Exemple de code

$KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default',

191


https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateAlias.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html


'version' => '2014-11-01', 'region' => 'us-east-2']);

$limit = 10;

try { $result = $KmsClient->listAliases([ 'Limit' => $limit, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Mise à jour d'un aliasPour associer un alias existant à une autre clé CMK, utilisez l’opération UpdateAlias.

Importations



Exemple de code


$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';$aliasName = "alias/projectKey1";

try { $result = $KmsClient->updateAlias([ 'AliasName' => $aliasName, 'TargetKeyId' => $keyId, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Suppression d'un aliasPour supprimer un alias, utilisez l’opération DeleteAlias. La suppression d'un alias n'a aucun effet sur la cléCMK sous-jacente.

192

https://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateAlias.html

https://docs.aws.amazon.com/kms/latest/APIReference/API_DeleteAlias.html

AWS SDK pour PHP Manuel du développeurExemples Amazon Kinesis

Importations



Exemple de code


$aliasName = "alias/projectKey1";

try { $result = $KmsClient->deleteAlias([ 'AliasName' => $aliasName, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Exemples Amazon Kinesis utilisant le kit AWS SDKfor PHP version 3

Amazon Kinesis est un service AWS qui collecte, traite et analyse les données en temps réel. Configurezvos flux de données avec Amazon Kinesis Data Streams ou utilisez Amazon Kinesis Data Firehose pourenvoyer des données à Amazon S3, Amazon ES, Amazon Redshift ou Splunk.

Pour plus d’informations sur Kinesis, consultez la documentation Amazon Kinesis.


Rubriques

193

https://docs.aws.amazon.com/kinesis/index.html



AWS SDK pour PHP Manuel du développeurKinesis Data Streams

• Création de flux de données à l’aide de l’API Kinesis Data Streams et du kit AWS SDK for PHPversion 3 (p. 194)

• Gestion des partitions de données à l’aide de l’API Kinesis Data Streams et du kit AWS SDK for PHPversion 3 (p. 198)

• Création de flux de diffusion à l’aide de l’API Kinesis Data Firehose et du kit AWS SDK for PHPversion 3 (p. 200)

Création de flux de données à l’aide de l’API KinesisData Streams et du kit AWS SDK for PHP version 3Amazon Kinesis Data Streams vous permet d’envoyer des données en temps réel. Créer un producteur dedonnées avec Kinesis Data Streams qui transfère les données vers la destination configurée chaque foisque vous ajoutez des données.

Pour plus d’informations, consultez la section Création et gestion de flux dans le Amazon Kinesis DataStreams Developer Guide.


• Créer un flux de données à l’aide de CreateAlias.• Obtenir des détails sur un flux de données unique à l’aide de DescribeStream.• Répertorier les flux de données existants à l’aide de ListStreams.• Envoyer des données à un flux de données existants à l’aide de PutRecord.• Supprimer un flux de données à l’aide de DeleteStream.



Pour plus d’informations sur l’utilisation de Amazon Kinesis Data Streams, consultez le manuel dudéveloppeur Amazon Kinesis Data Streams.

Créer un flux de données à l’aide de Kinesis Data StreamCréer un flux de données Kinesis où vous pouvez envoyer les informations que Kinesis va traiter à l’aidede l’exemple de code suivant. Découvrez-en davantage à la section Création et mise à jour des flux dedonnées dans le Amazon Kinesis Data Streams Developer Guide.

Pour créer un flux de données Kinesis, utilisez l’opération CreateStream.

Importations


use Aws\Kinesis\KinesisClient; use Aws\Exception\AwsException;

194

https://docs.aws.amazon.com/kinesis/latest/dev/working-with-streams.html.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#createstream

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#describestream

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#liststreams

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#putrecord

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#deletestream



https://docs.aws.amazon.com/kinesis/latest/dev/


https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html

https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html


Exemple de code

$kinesisClient = new Aws\Kinesis\KinesisClient([ 'profile' => 'default', 'version' => '2013-12-02', 'region' => 'us-east-2']);

$shardCount = 2;$name = "my_stream_name";

try { $result = $kinesisClient->createStream([ 'ShardCount' => $shardCount, 'StreamName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Récupérer un flux de donnéesObtenez des détails sur un flux de données existant à l’aide de l’exemple de code suivant. Par défaut, ilrenvoie des informations sur les 10 premières partitions connectées au flux de données Kinesis indiqué.N’oubliez pas de vérifier le StreamStatus de la réponse avant d’écrire des données sur un flux dedonnées Kinesis.

Pour récupérer les détails relatifs à un flux de données Kinesis, utilisez l’opération DescribeStream.

Importations



Exemple de code


$name = "my_stream_name";

try { $result = $kinesisClient->describeStream([ 'StreamName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";

195

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html


}

Répertorier les flux de données existants connectés à KinesisRépertoriez les 10 premiers flux de données de votre compte AWS dans la région AWS sélectionnée.Utilisez le `HasMoreStreams retourné pour déterminer si plusieurs flux sont associés à votre compte.

Pour répertorier vos flux de données Kinesis, utilisez l’opération ListStreams.

Importations



Exemple de code


try { $result = $kinesisClient->listStreams([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Envoyer des données à un flux de données existantUne fois qu’un flux de données est créé, utilisez l’exemple suivant pour envoyer des données. Avant d’yenvoyer des données, utilisez DescribeStream pour vérifier si les données StreamStatus sont actives.

Pour écrire un seul enregistrement de données sur un flux de données Kinesis, utilisez l’opérationPutRecord. Pour écrire jusqu’à 500 enregistrements dans un flux de données Kinesis, utilisez l’opérationPutRecords.

Importations



Exemple de code

$kinesisClient = new Aws\Kinesis\KinesisClient([ 'profile' => 'default',

196

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html


'version' => '2013-12-02', 'region' => 'us-east-1']);

$name = "my_stream_name";$content = '{"ticker_symbol":"QXZ", "sector":"HEALTHCARE", "change":-0.05, "price":84.51}';$groupID = "input to a hash function that maps the partition key (and associated data) to a specific shard";

try { $result = $kinesisClient->PutRecord([ 'Data' => $content, 'StreamName' => $name, 'PartitionKey' => $groupID ]); print("<p>ShardID = " . $result["ShardId"] . "</p>"); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer un flux de donnéesCet exemple indique comment supprimer un flux de données. La suppression d’un flux de donnéesentraîne également la suppression des données envoyées au flux de données. Les flux de donnéesKinesis actifs passent à l’état SUPPRESSION EN COURS jusqu’à la fin de la suppression du flux. Lorsqu’ilest à l’état SUPPRESSION EN COURS, le flux continue à traiter des données.

Pour supprimer un flux de données Kinesis, utilisez l’opération DeleteStream.

Importations



Exemple de code



try { $result = $kinesisClient->deleteStream([ 'StreamName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

197

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html

AWS SDK pour PHP Manuel du développeurPartitions Kinesis

Gestion des partitions de données à l’aide de l’APIKinesis Data Streams et du kit AWS SDK for PHPversion 3Amazon Kinesis Data Streams vous permet d’envoyer des données en temps réel vers un point determinaison. Le débit du flux de données varie en fonction du nombre de partitions dans votre flux.

Vous pouvez écrire 1 000 enregistrements par seconde sur une seule partition. Chaque partition disposeégalement d’une limite de chargement de 1 Mo par seconde. L’utilisation est calculée et facturée parpartition, de manière à utiliser ces exemples pour gérer les données de capacité et de coût de votre flux.


• Répertorier les partitions dans un flux à l’aide de ListShards.• Ajouter ou réduire le nombre de partitions présentes dans un flux à l’aide d’UpdateShardCount.



Pour plus d’informations sur l’utilisation de Amazon Kinesis Data Streams, consultez le manuel dudéveloppeur Amazon Kinesis Data Streams.

Répertorier les partitions dans un flux de donnéesRépertorier les détails de jusqu’à 100 partitions dans un flux spécifique.

Pour répertorier les partitions dans un flux de données Kinesis, utilisez l’opération ListShards.

Importations



Exemple de code



198

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#listshards

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#updateshardcount





https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html

AWS SDK pour PHP Manuel du développeurPartitions Kinesis

try { $result = $kinesisClient->ListShards([ 'StreamName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Ajouter davantage de partitions de flux de donnéesSi vous avez besoin de davantage de partitions de flux de données, vous pouvez augmenter lenombre actuel de partitions. Nous vous recommandons de doubler votre nombre de partition en casd’augmentation. Ainsi, chaque partition actuellement disponible est copiée afin d'augmenter votre capacité.Vous ne pouvez doubler le nombre de vos partitions que deux fois par période de 24 heures.

N'oubliez pas que la facturation de l'utilisation du Kinesis Data Streams est calculée par partition. Ainsi,lorsque la demande diminue, nous vous recommandons de réduire le nombre de partitions de moitié.Lorsque vous supprimez des partitions, vous pouvez uniquement réduire la quantité de partitions à la moitiéde votre nombre de partitions actuel.

Pour mettre à jour le nombre de partitions d’un flux de données Kinesis, utilisez l’opérationUpdateShardCount.

Importations



Exemple de code


$name = "my_stream_name";$totalshards = 4;

try { $result = $kinesisClient->UpdateShardCount([ 'ScalingType' => 'UNIFORM_SCALING', 'StreamName' => $name, 'TargetShardCount' => $totalshards ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

199

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_UpdateShardCount.html

AWS SDK pour PHP Manuel du développeurFlux de diffusion Kinesis Data Firehose

Création de flux de diffusion à l’aide de l’API KinesisData Firehose et du kit AWS SDK for PHP version 3Amazon Kinesis Data Firehose vous permet d’envoyer des données en temps réel à d’autres servicesAWS, y compris Amazon Kinesis Data Streams, Amazon S3, Amazon Elasticsearch Service (Amazon ES)et Amazon Redshift ou à Splunk. Créer un producteur de données avec les flux de diffusion pour transférerdes données vers la destination configurée chaque fois que vous ajoutez des données.


• Créer un flux de diffusion à l’aide de CreateDeliveryStream.• Obtenir des détails sur un flux de diffusion unique à l’aide de DescribeDeliveryStream.• Répertorier vos flux de diffusion à l’aide de ListDeliveryStreams.• Envoyer des données à un flux de diffusion à l’aide de PutRecord.• Supprimer un flux de diffusion à l’aide de DeleteDeliveryStream.



Pour plus d’informations sur l’utilisation de Amazon Kinesis Data Firehose, consultez le manuel dudéveloppeur Amazon Kinesis Data Firehose.

Créer un flux de diffusion à l’aide du flux de données Kinesis.Pour créer un flux de diffusion qui place des données dans un flux de données Kinesis existant, utilisezl’opération CreateDeliveryStream.

Ceci permet aux développeurs de migrer les services Kinesis existants vers Kinesis Data Firehose.

Importations


use Aws\Firehose\FirehoseClient; use Aws\Exception\AwsException;

Exemple de code

$firehoseClient = new Aws\Firehose\FirehoseClient([ 'profile' => 'default', 'version' => '2015-08-04', 'region' => 'us-east-2']);

$name = "my_stream_name";$stream_type = "KinesisStreamAsSource";$kinesis_stream = "arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name";

200

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#createdeliverystream

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#describedeliverystream

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#listdeliverystreams

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#putrecord

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#deletedeliverystream



https://docs.aws.amazon.com/firehose/latest/dev/

https://docs.aws.amazon.com/firehose/latest/dev/

https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html


$role = "arn:aws:iam::0123456789:policy/Role";

try { $result = $firehoseClient->createDeliveryStream([ 'DeliveryStreamName' => $name, 'DeliveryStreamType' => $stream_type, 'KinesisStreamSourceConfiguration' => [ 'KinesisStreamARN' => $kinesis_stream, 'RoleARN' => $role, ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Créer un flux de diffusion à l’aide d’un compartiment Amazon S3Pour créer un flux de diffusion qui place des données dans un compartiment Amazon S3 existant, utilisezl’opération CreateDeliveryStream.

Indiquez les paramètres de destination, comme indiqué dans la section Paramètres de destination. Ensuite,veillez à accorder à votre compartiment Amazon S3 l’accès à Kinesis Data Firehose, comme indiqué dansla section Octroi à une destination Amazon S3 de l’accès à Kinesis Data Firehose.

Importations



Exemple de code


$name = "my_S3_stream_name";$stream_type = "DirectPut";$s3bucket = 'arn:aws:s3:::bucket_name';$s3Role = 'arn:aws:iam::0123456789:policy/Role';

try { $result = $firehoseClient->createDeliveryStream([ 'DeliveryStreamName' => $name, 'DeliveryStreamType' => $stream_type, 'S3DestinationConfiguration' => [ 'BucketARN' => $s3bucket, 'CloudWatchLoggingOptions' => [ 'Enabled' => false, ], 'RoleARN' => $s3Role ], ]);

201


https://docs.aws.amazon.com/firehose/latest/dev/create-destination.html

https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3.html


var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Créer un flux de diffusion à l’aide d’Amazon ESPour créer un flux de diffusion Kinesis Data Firehose qui place des données dans un cluster Amazon ES,utilisez l’opération CreateDeliveryStream.

Indiquez les paramètres de destination, comme indiqué dans la section Paramètres de destination. Veillezà accorder à votre cluster Amazon ES l’accès à Kinesis Data Firehose, comme indiqué dans la sectionOctroi à une destination Amazon ES de l’accès à Kinesis Data Firehose.

Importations



Exemple de code


$name = "my_ES_stream_name";$stream_type = "DirectPut";$esDomainARN = 'arn:aws:es:us-east-2:0123456789:domain/Name';$esRole = 'arn:aws:iam::0123456789:policy/Role';$esIndex = 'root';$esType = 'PHP_SDK';$s3bucket = 'arn:aws:s3:::bucket_name';$s3Role = 'arn:aws:iam::0123456789:policy/Role';

try { $result = $firehoseClient->createDeliveryStream([ 'DeliveryStreamName' => $name, 'DeliveryStreamType' => $stream_type, 'ElasticsearchDestinationConfiguration' => [ 'DomainARN' => $esDomainARN, 'IndexName' => $esIndex, 'RoleARN' => $esRole, 'S3Configuration' => [

'BucketARN' => $s3bucket, 'CloudWatchLoggingOptions' => [ 'Enabled' => false, ], 'RoleARN' => $s3Role,

],

'TypeName' => $esType,

202


https://docs.aws.amazon.com/firehose/latest/dev/create-destination.html

https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-es.html


], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Récupérer un flux de diffusionPour obtenir des informations détaillées sur un flux de diffusion Kinesis Data Firehose existant, utilisezl’opération DescribeDeliveryStream.

Importations



Exemple de code



try { $result = $firehoseClient->describeDeliveryStream([ 'DeliveryStreamName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier les flux de diffusion existants connectés à KinesisData StreamsPour répertorier tous les flux de diffusion Kinesis Data Firehose existants qui envoient des données àKinesis Data Streams, utilisez l’opération ListDeliveryStreams.

Importations


use Aws\Firehose\FirehoseClient;

203

https://docs.aws.amazon.com/firehose/latest/APIReference/API_DescribeDeliveryStream.html

https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html



Exemple de code


try { $result = $firehoseClient->listDeliveryStreams([ 'DeliveryStreamType' => 'KinesisStreamAsSource', ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier les flux de diffusion qui envoient des données àd’autres services AWSPour répertorier tous les flux de diffusion Kinesis Data Firehose existants qui envoient des données àAmazon S3, Amazon ES ou Amazon Redshift ou à Splunk, utilisez l’opération ListDeliveryStreams.

Importations



Exemple de code


try { $result = $firehoseClient->listDeliveryStreams([ 'DeliveryStreamType' => 'DirectPut', ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

204

https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html


Envoyer des données à un flux de diffusion Kinesis Data FirehoseexistantPour envoyer des données via votre flux de diffusion Kinesis Data Firehose à une destination donnée,utilisez l’opération PutRecord après avoir créer un flux de diffusion Kinesis Data Firehose.

Avant d’envoyer des données à un flux de diffusion Kinesis Data Firehose de diffusion, utilisezDescribeDeliveryStream pour voir si le flux de diffusion est actif.

Importations



Exemple de code


$name = "my_stream_name";$content = '{"ticker_symbol":"QXZ", "sector":"HEALTHCARE", "change":-0.05, "price":84.51}';

try { $result = $firehoseClient->putRecord([ 'DeliveryStreamName' => $name, 'Record' => [ 'Data' => $content, ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer un flux de diffusion Kinesis Data FirehosePour supprimer un flux de diffusion Kinesis Data Firehose, utilisez l’opération DeleteDeliveryStreams. Cecisupprime également toutes les données envoyées dans le flux de diffusion.

Importations



Exemple de code

205

https://docs.aws.amazon.com/firehose/latest/APIReference/API_API_PutRecord.html

https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeleteDeliveryStreams.html

AWS SDK pour PHP Manuel du développeurAWS Elemental MediaConvert



try { $result = $firehoseClient->deleteDeliveryStream([ 'DeliveryStreamName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

AWS Elemental MediaConvert Exemples utilisant lekit AWS SDK for PHP version 3

AWS Elemental MediaConvert est un service de transcodage vidéo basé sur des fichiers avec desfonctions de niveau diffuseur. Vous pouvez utiliser ce service pour créer des ressources afin de fournir unediffusion et des vidéos à la demande (VOD) sur Internet. Pour plus d’informations, consultez le Guide del’utilisateur d’AWS Elemental MediaConvert.

L’API PHP pour AWS Elemental MediaConvert est exposée via la classe client AWS.MediaConvert. Pourplus d’informations, consultez la section Classe : AWS.MediaConvert dans la référence de l’API.



Rubriques

206

https://docs.aws.amazon.com/mediaconvert/latest/ug/


https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-mediaconvert-2017-08-29.html



AWS SDK pour PHP Manuel du développeurObtention du point de terminaison propre à votre compte

• Obtention du point de terminaison propre à votre compte pour AWS Elemental MediaConvert avec le kitAWS SDK for PHP version 3 (p. 207)

• Création et gestion de tâches de transcodage dans AWS Elemental MediaConvert avec le kit AWSSDK for PHP version 3 (p. 208)

Obtention du point de terminaison propre à votrecompte pour AWS Elemental MediaConvert avec le kitAWS SDK for PHP version 3Dans cet exemple, vous utilisez le kit AWS SDK for PHP version 3 pour appeler AWS ElementalMediaConvert et récupérer le point de terminaison propre à votre compte. Vous pouvez récupérer l'URLde votre point de terminaison à partir du point de terminaison par défaut du service. Vous n'avez donc pasencore besoin du point de terminaison propre à votre compte.


• Récupérer le point de terminaison propre à votre compte à l’aide de DescribeEndpoints.



Pour accéder au client MediaConvert, créez un rôle IAM qui permet à AWS Elemental MediaConvertd’accéder à vos fichiers d’entrée et aux compartiments Amazon S3 où vos fichiers de sortie sont stockés.Pour en savoir plus, consultez la section Configuration des autorisations IAM dans le Guide de l’utilisateurAWS Elemental MediaConvert.

Récupération de points de terminaisonCréez un objet pour transmettre les paramètres de demande vides pour la méthode describeEndpoints dela classe client AWS.MediaConvert. Pour appeler la méthode describeEndpoints, créez une promessepour appeler un objet de service AWS Elemental MediaConvert, en transmettant les paramètres. Traitez laréponse dans le rappel de promesse.

Importations


use Aws\MediaConvert\MediaConvertClient; use Aws\Exception\AwsException;

Exemple de code

Définissez la région dans laquelle vous souhaitez obtenir le point de terminaison et créez un objet clientMediaConvert :

$client = new Aws\MediaConvert\MediaConvertClient([

207

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-mediaconvert-2017-08-29.html#describeendpoints



https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html



AWS SDK pour PHP Manuel du développeurCréation et gestion de tâches

'profile' => 'default', 'version' => '2017-08-29', 'region' => 'us-east-2']);

//retrieve endpointtry { $result = $client->describeEndpoints([]);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Appelez la méthode describeEndpoints pour récupérer les points de terminaison et enregistrez l'URL dupoint de terminaison :

$single_endpoint_url = $result['Endpoints'][0]['Url'];

print("Your endpoint is " . $single_endpoint_url);

//Create an AWSMediaConvert client object with the endpoint URL that you retrieved: $mediaConvertClient = new MediaConvertClient([ 'version' => '2017-08-29', 'region' => 'us-east-2', 'profile' => 'default', 'endpoint' => $single_endpoint_url]);

Création et gestion de tâches de transcodage dansAWS Elemental MediaConvert avec le kit AWS SDKfor PHP version 3Dans cet exemple, vous utilisez le kit AWS SDK for PHP version 3 pour appeler AWS ElementalMediaConvert et créer une tâche de transcodage. Avant de commencer, vous devez charger la vidéod'entrée dans le compartiment Amazon S3 que vous avez alloué pour le stockage d'entrée. Pour obtenir laliste des conteneurs et des codecs vidéo d’entrée pris en charge, consultez la section Codecs d’entrée etconteneurs pris en charge dans le Guide de l’utilisateur AWS Elemental MediaConvert.


• Créer des tâches de transcodage dans AWS Elemental MediaConvert. CreateJob.• Annuler une tâche de transcodage à partir de la file d'attente AWS Elemental MediaConvert. CancelJob• Récupérer le code JSON pour une tâche de transcodage terminée. GetJob• Récupérer un tableau JSON pour jusqu'à 20 tâches créées en dernier. ListJobs



208

https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html

https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html


https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-mediaconvert-2017-08-29.html#createjob

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-mediaconvert-2017-08-29.html#canceljob

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-mediaconvert-2017-08-29.html#getjob

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-mediaconvert-2017-08-29.html#listjobs





Pour accéder au client MediaConvert, créez un rôle IAM qui permet à AWS Elemental MediaConvertd’accéder à vos fichiers d’entrée et aux compartiments Amazon S3 où vos fichiers de sortie sont stockés.Pour en savoir plus, consultez la section Configuration des autorisations IAM dans le Guide de l’utilisateurAWS Elemental MediaConvert.

Création d'un clientConfigurez le kit AWS SDK for PHP en créant un client MediaConvert, avec la région pour votre code.Dans cet exemple, la région est définie sur us-west-2. Comme AWS Elemental MediaConvert utilise despoints de terminaison personnalisés pour chaque compte, configurez AWS.MediaConvert clientclass pour utiliser le point de terminaison propre à votre compte. Pour ce faire, définissez le paramètre depoint de terminaison sur le point de terminaison propre à votre compte (p. 207).

Importations


use Aws\MediaConvert\MediaConvertClient; use Aws\Exception\AwsException;

Exemple de code

$mediaConvertClient = new MediaConvertClient([ 'version' => '2017-08-29', 'region' => 'us-east-2', 'profile' => 'default', 'endpoint' => 'ACCOUNT_ENDPOINT']);

Définition d'une tâche de transcodage simpleCréez le code JSON qui définit les paramètres de tâche de transcodage.

Ces paramètres sont détaillés. Vous pouvez utiliser la console AWS Elemental MediaConvert pourgénérer les paramètres de tâche JSON en choisissant vos paramètres de tâche dans la console, puis ensélectionnant Show job JSON (Afficher JSON de tâche) dans la section Job (Tâche). Cet exemple illustre lecode JSON pour une tâche simple.

Exemple de code

$jobSetting = [ "OutputGroups" => [ [ "Name" => "File Group", "OutputGroupSettings" => [ "Type" => "FILE_GROUP_SETTINGS", "FileGroupSettings" => [ "Destination" => "s3://OUTPUT_BUCKET_NAME/" ] ], "Outputs" => [ [ "VideoDescription" => [ "ScalingBehavior" => "DEFAULT", "TimecodeInsertion" => "DISABLED", "AntiAlias" => "ENABLED",

209

https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html



https://console.aws.amazon.com/mediaconvert/home


"Sharpness" => 50, "CodecSettings" => [ "Codec" => "H_264", "H264Settings" => [ "InterlaceMode" => "PROGRESSIVE", "NumberReferenceFrames" => 3, "Syntax" => "DEFAULT", "Softness" => 0, "GopClosedCadence" => 1, "GopSize" => 90, "Slices" => 1, "GopBReference" => "DISABLED", "SlowPal" => "DISABLED", "SpatialAdaptiveQuantization" => "ENABLED", "TemporalAdaptiveQuantization" => "ENABLED", "FlickerAdaptiveQuantization" => "DISABLED", "EntropyEncoding" => "CABAC", "Bitrate" => 5000000, "FramerateControl" => "SPECIFIED", "RateControlMode" => "CBR", "CodecProfile" => "MAIN", "Telecine" => "NONE", "MinIInterval" => 0, "AdaptiveQuantization" => "HIGH", "CodecLevel" => "AUTO", "FieldEncoding" => "PAFF", "SceneChangeDetect" => "ENABLED", "QualityTuningLevel" => "SINGLE_PASS", "FramerateConversionAlgorithm" => "DUPLICATE_DROP", "UnregisteredSeiTimecode" => "DISABLED", "GopSizeUnits" => "FRAMES", "ParControl" => "SPECIFIED", "NumberBFramesBetweenReferenceFrames" => 2, "RepeatPps" => "DISABLED", "FramerateNumerator" => 30, "FramerateDenominator" => 1, "ParNumerator" => 1, "ParDenominator" => 1 ] ], "AfdSignaling" => "NONE", "DropFrameTimecode" => "ENABLED", "RespondToAfd" => "NONE", "ColorMetadata" => "INSERT" ], "AudioDescriptions" => [ [ "AudioTypeControl" => "FOLLOW_INPUT", "CodecSettings" => [ "Codec" => "AAC", "AacSettings" => [ "AudioDescriptionBroadcasterMix" => "NORMAL", "RateControlMode" => "CBR", "CodecProfile" => "LC", "CodingMode" => "CODING_MODE_2_0", "RawFormat" => "NONE", "SampleRate" => 48000, "Specification" => "MPEG4", "Bitrate" => 64000 ] ], "LanguageCodeControl" => "FOLLOW_INPUT", "AudioSourceName" => "Audio Selector 1" ] ], "ContainerSettings" => [

210


"Container" => "MP4", "Mp4Settings" => [ "CslgAtom" => "INCLUDE", "FreeSpaceBox" => "EXCLUDE", "MoovPlacement" => "PROGRESSIVE_DOWNLOAD" ] ], "NameModifier" => "_1" ] ] ] ], "AdAvailOffset" => 0, "Inputs" => [ [ "AudioSelectors" => [ "Audio Selector 1" => [ "Offset" => 0, "DefaultSelection" => "NOT_DEFAULT", "ProgramSelection" => 1, "SelectorType" => "TRACK", "Tracks" => [ 1 ] ] ], "VideoSelector" => [ "ColorSpace" => "FOLLOW" ], "FilterEnable" => "AUTO", "PsiControl" => "USE_PSI", "FilterStrength" => 0, "DeblockFilter" => "DISABLED", "DenoiseFilter" => "DISABLED", "TimecodeSource" => "EMBEDDED", "FileInput" => "s3://INPUT_BUCKET_AND_FILE_NAME" ] ], "TimecodeConfig" => [ "Source" => "EMBEDDED" ]]

Créer une tâcheAprès avoir créé les paramètres de tâche JSON, appelez la méthode createJob en appelant un objetAWS.MediaConvert service object et en transmettant les paramètres. L'ID de la tâche créée estrenvoyé dans les données de réponse.

Exemple de code

try { $result = $mediaConvertClient->createJob([ "Role" => "IAM_ROLE_ARN", "Settings" => $jobSetting, //JobSettings structure "Queue" => "JOB_QUEUE_ARN", "UserMetadata" => [ "Customer" => "Amazon" ], ]);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";

211


}

Récupération d'une tâcheAvec le JobID renvoyé lorsque vous avez appelé createjob, vous pouvez obtenir des descriptions détailléesdes tâches récentes au format JSON.

Exemple de code


try { $result = $mediaConvertClient->getJob([ 'Id' => 'JOB_ID', ]);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Annulation d'une tâcheAvec le JobID renvoyé lorsque vous avez appelé createjob, vous pouvez annuler une tâche pendantqu'elle est encore dans la file d'attente. Vous ne pouvez pas annuler des tâches qui ont déjà commencé letranscodage.

Exemple de code


try { $result = $mediaConvertClient->cancelJob([ 'Id' => 'JOB_ID', // REQUIRED The Job ID of the job to be cancelled. ]);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Affichage de la liste des tâches de transcodage récentesCréez le code JSON des paramètres, y compris les valeurs pour spécifier si vous souhaitez trier la listedans l'ordre ASCENDING (croissant) ou DESCENDING (décroissant), l'ARN de la file d'attente de tâches

212

AWS SDK pour PHP Manuel du développeurExemples Amazon S3

à vérifier et le statut des tâches à inclure. Cela renvoie jusqu'à 20 tâches. Pour récupérer les 20 tâches lesplus récentes suivantes, utilisez la chaîne nextToken renvoyée avec le résultat.

Exemple de code


try { $result = $mediaConvertClient->listJobs([ 'MaxResults' => 20, 'Order' => 'ASCENDING', 'Queue' => 'QUEUE_ARN', 'Status' => 'SUBMITTED', // 'NextToken' => '<string>', //OPTIONAL To retrieve the twenty next most recent jobs ]);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Exemples Amazon S3 avec le kit AWS SDK forPHP version 3

Amazon Simple Storage Service (Amazon S3) est un service Web qui offre un stockage dans le cloudextrêmement évolutif. Amazon S3 assure un stockage d’objet facile à utiliser, avec une interface deservices Web simples pour stocker et récupérer n’importe quelle quantité de données, n’importe où sur leWeb.



213



AWS SDK pour PHP Manuel du développeurCréation et utilisation de compartiments Amazon S3


Rubriques• Création et utilisation de compartiments Amazon S3 avec le kit AWS SDK pour PHP

version 3 (p. 214)• Gestion des autorisations d’accès aux compartiments Amazon S3 avec le kit AWS SDK pour PHP

version 3 (p. 216)• Configuration de compartiments Amazon S3 avec le kit AWS SDK pour PHP version 3 (p. 218)• Utilisation de chargements partitionnés Amazon S3 avec le kit AWS SDK pour PHP version 3 (p. 220)• POST pré-signés Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 227)• URL pré-signées Amazon S3 avec le kit AWS SDK for PHP version 3 (p. 228)• Utilisation d’un compartiment Amazon S3 en tant qu’hôte Web statique avec le kit AWS SDK for PHP

version 3 (p. 230)• Utilisation de stratégies de compartiment Amazon S3 avec le kit AWS SDK pour PHP

version 3 (p. 231)

Création et utilisation de compartiments Amazon S3avec le kit AWS SDK pour PHP version 3Les exemples suivants montrent comment :

• Renvoyer une liste des compartiments détenus par l’expéditeur authentifié de la demande à l’aide deListBuckets.

• Créer un nouveau compartiment à l’aide de CreateBucket.• Ajouter un objet à un compartiment à l’aide de PutObject.



Importations


use Aws\S3\S3Client; use Aws\Exception\AwsException;

Etablir une liste des compartimentsCréez un fichier PHP avec le code suivant. Commencez par créer un service client AWS.S3 qui spécifie larégion et la version AWS. Appelez ensuite la méthode listBuckets, qui renvoie tous les compartimentsAmazon S3 détenus par l'expéditeur de la demande sous forme de tableau de structures de compartiment.

Exemple de code

214

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#listbuckets

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#createbucket

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject



AWS SDK pour PHP Manuel du développeurCréation et utilisation de compartiments Amazon S3

$s3Client = new S3Client([ 'profile' => '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";}

Créer un compartimentCréez un fichier PHP avec le code suivant. Commencez par créer un service client AWS.S3 qui spécifiela région et la version AWS. Appelez ensuite la méthode createBucket avec un tableau commeparamètre. Le seul champ obligatoire est le compartiment (« Bucket ») clé, avec une valeur de chaînepour le nom du compartiment à créer. Cependant, vous pouvez spécifier la région AWS dans le champ« CreateBucketConfiguration ». Si elle aboutit, cette méthode renvoie l'emplacement (« Location ») ducompartiment.

Exemple de code

class CreateBucketExample{ private $s3Client = null;

public function __construct($s3Client) { $this->s3Client = $s3Client; }

/* ////////////////////////////////////////////////////////////////////////

Purpose: Creates a bucket in Amazon S3.

Inputs:

- $bucketName: The name of the bucket to create.

Returns: true if the bucket was created; otherwise, false.

//////////////////////////////////////////////////////////////////////// */ public function createBucket($bucketName) { try { $result = $this->s3Client->createBucket([ 'Bucket' => $bucketName, ]); } catch (AwsException $e) { echo $e->getMessage(); echo "\n"; return false; }

if ($result['@metadata']['statusCode'] == 200) { return true; } else { return false; }

215

AWS SDK pour PHP Manuel du développeurGestion des autorisations d’accèsaux compartiments Amazon S3

} }

Placer un objet dans un compartimentPour ajouter des fichiers à votre nouveau compartiment, créez un fichier PHP avec le code suivant.

Dans votre ligne de commande, exécutez ce fichier et transmettez le nom du compartiment dans lequelvous souhaitez charger votre fichier sous forme de chaîne, suivi par le chemin d’accès complet du fichier àcharger.

Exemple de code

$USAGE = "\n" . "To run this example, supply the name of an S3 bucket and a file to\n" . "upload to it.\n" . "\n" . "Ex: php PutObject.php <bucketname> <filename>\n";

if (count($argv) <= 2) { echo $USAGE; exit();}

$bucket = $argv[1];$file_Path = $argv[2];$key = basename($argv[2]);

try { //Create a S3Client $s3Client = new S3Client([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2006-03-01' ]); $result = $s3Client->putObject([ 'Bucket' => $bucket, 'Key' => $key, 'SourceFile' => $file_Path, ]);} catch (S3Exception $e) { echo $e->getMessage() . "\n";}

Gestion des autorisations d’accès aux compartimentsAmazon S3 avec le kit AWS SDK pour PHP version 3Les listes de contrôle d'accès (ACL) sont l'une des options de la stratégie d'accès basée sur les ressourcesque vous pouvez utiliser pour gérer l'accès aux compartiments et objets. Vous pouvez utiliser des listesACL pour accorder les autorisations en lecture/écriture de base à d'autres comptes AWS. Pour en savoirplus, consultez la section Gestion des accès avec les listes ACL.

L’exemple suivant indique comment :

• Obtenir la stratégie de contrôle d’accès pour un compartiment à l’aide de GetBucketAcl.• Définir les autorisations au niveau d’un compartiment en utilisant les listes ACL, à l’aide de PutBucketAcl.

216

https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketacl

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketacl

AWS SDK pour PHP Manuel du développeurGestion des autorisations d’accèsaux compartiments Amazon S3



Obtenir et définir une stratégie de liste de contrôle d'accèsImportations



Exemple de code

// Create a S3Client $s3Client = new S3Client([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2006-03-01']);

// Gets the access control policy for a bucket$bucket = 'my-s3-bucket';try { $resp = $s3Client->getBucketAcl([ 'Bucket' => $bucket ]); echo "Succeed in retrieving bucket ACL as follows: \n"; var_dump($resp);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

// Sets the permissions on a bucket using access control lists (ACL).$params = [ 'ACL' => 'public-read', 'AccessControlPolicy' => [ // Information can be retrieved from `getBucketAcl` response 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'EmailAddress' => '<string>', 'ID' => '<string>', 'Type' => 'CanonicalUser', 'URI' => '<string>', ], 'Permission' => 'FULL_CONTROL', ], // ... ], 'Owner' => [

217



AWS SDK pour PHP Manuel du développeurConfiguration de compartiments Amazon S3

'DisplayName' => '<string>', 'ID' => '<string>', ], ], 'Bucket' => $bucket,];

try { $resp = $s3Client->putBucketAcl($params); echo "Succeed in setting bucket ACL.\n";} catch (AwsException $e) { // Display error message echo $e->getMessage(); echo "\n";}

Configuration de compartiments Amazon S3 avec le kitAWS SDK pour PHP version 3Le partage des ressources cross-origin (CORS) définit un moyen pour les applications Web clienteschargées dans un domaine particulier d'interagir avec les ressources d'un autre domaine. Avec le supportCORS dans Amazon S3, vous pouvez créer de riches applications Web clientes avec Amazon S3 et demanière sélective permettre un accès cross-origin aux ressources Amazon S3.

Pour plus d’informations sur l’utilisation de la configuration CORS avec un compartiment Amazon S3,consultez la section Partage des ressources cross-origin (CORS).


• Obtenir la configuration CORS d’un compartiment à l’aide de GetBucketCors.• Définir la configuration CORS d’un compartiment à l’aide de PutBucketCors.



Obtenir la configuration CORSCréez un fichier PHP avec le code suivant. Commencez par créer un service client AWS.S3, puis appelezla méthode getBucketCors et spécifiez le compartiment dont vous souhaitez définir la configurationCORS.

Le seul paramètre obligatoire est le nom du compartiment sélectionné. Si le compartiment dispose d’uneconfiguration CORS, cette configuration est renvoyée par Amazon S3 en tant qu’objet CORSRules.

Importations

218

https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketcors

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketcors



https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-s3-2006-03-01.html#shape-corsrule

AWS SDK pour PHP Manuel du développeurConfiguration de compartiments Amazon S3



Exemple de code

$client = new S3Client([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2006-03-01']);

try { $result = $client->getBucketCors([ 'Bucket' => $bucketName, // REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Définir la configuration CORSCréez un fichier PHP avec le code suivant. Commencez par créer un service client AWS.S3. Appelezensuite la méthode putBucketCors, spécifiez le compartiment dont la configuration CORS doit êtredéfinie et définissez la CORSConfiguration comme objet JSON CORSRules.

Importations



Exemple de code

$client = new S3Client([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2006-03-01']);

try { $result = $client->putBucketCors([ 'Bucket' => $bucketName, // REQUIRED 'CORSConfiguration' => [ // REQUIRED 'CORSRules' => [ // REQUIRED [ 'AllowedHeaders' => ['Authorization'], 'AllowedMethods' => ['POST', 'GET', 'PUT'], // REQUIRED 'AllowedOrigins' => ['*'], // REQUIRED 'ExposeHeaders' => [], 'MaxAgeSeconds' => 3000 ], ], ]

219

https://docs.aws.amazon.com/aws-sdk-php/v3/api//api-s3-2006-03-01.html#shape-corsrule

AWS SDK pour PHP Manuel du développeurChargements partitionnés Amazon S3

]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation de chargements partitionnés Amazon S3avec le kit AWS SDK pour PHP version 3Vous pouvez charger des objets de taille inférieure ou égale à 5 Go à l'aide d'une simpleopération PutObject. Cependant, les méthodes de chargement partitionné (par exemple,CreateMultipartUpload, UploadPart, CompleteMultipartUpload et AbortMultipartUpload)vous permettent de charger des objets dont la taille est comprise entre 5 Mo et 5 To.


• Charger un objet vers Amazon S3 en utilisant ObjectUploader.• Créer un chargement partitionné pour un objet Amazon S3 en utilisant MultipartUploader.• Copier des objets d'un emplacement Amazon S3 vers un autre en utilisant ObjectCopier.



Object UploaderSi vous hésitez entre PutObject et MultipartUploader pour effectuer la tâche, utilisezObjectUploader. ObjectUploader charge un fichier volumineux vers Amazon S3 en utilisantPutObject ou MultipartUploader, selon la taille de la charge utile.


use Aws\S3\S3Client;use Aws\Exception\AwsException;use Aws\S3\ObjectUploader;

Exemple de code

$s3Client = new S3Client([ 'profile' => 'default', 'region' => 'us-east-2', 'version' => '2006-03-01']);

$bucket = 'your-bucket';

220

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.ObjectUploader.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.MultipartUploader.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.ObjectCopier.html




$key = 'my-file.zip';

// Using stream instead of file path$source = fopen('/path/to/large/file.zip', 'rb');

$uploader = new ObjectUploader( $s3Client, $bucket, $key, $source);

do { try { $result = $uploader->upload(); if ($result["@metadata"]["statusCode"] == '200') { print('<p>File successfully uploaded to ' . $result["ObjectURL"] . '.</p>'); } print($result); } catch (MultipartUploadException $e) { rewind($source); $uploader = new MultipartUploader($s3Client, $source, [ 'state' => $e->getState(), ]); }} while (!isset($result));

MultipartUploaderLes chargements partitionnés sont conçus pour améliorer l'expérience de chargement pour les objetsvolumineux. Ils vous permettent de charger des parties d'objets indépendamment, dans n'importe quelordre, et en parallèle.

Nous encourageons les clients Amazon S3 à utiliser les chargements partitionnés pour les objets de taillesupérieure à 100 Mo.

Objet MultipartUploaderLe kit SDK dispose d'un objet MultipartUploader spécial qui simplifie le processus de chargementpartitionné.

Importations


use Aws\S3\S3Client;use Aws\Exception\AwsException;use Aws\S3\MultipartUploader;use Aws\Exception\MultipartUploadException;

Exemple de code


// Use multipart upload$source = '/path/to/large/file.zip';

221


$uploader = new MultipartUploader($s3Client, $source, [ 'bucket' => 'your-bucket', 'key' => 'my-file.zip',]);

try { $result = $uploader->upload(); echo "Upload complete: {$result['ObjectURL']}\n";} catch (MultipartUploadException $e) { echo $e->getMessage() . "\n";}

Le chargeur crée un générateur de données partitionnées, en fonction de la source et de la configurationfournies, et tente de charger toutes les parties. Si le chargement de certaines parties échoue, le chargeurcontinue le chargement des autres parties jusqu'à ce que l'ensemble des données source soient lues.Par la suite, le chargeur tente de charger les parties ayant échoué ou lève une exception contenant desinformations sur ces dernières.

Personnalisation d'un chargement partitionnéVous pouvez définir des options personnalisées sur les opérations CreateMultipartUpload,UploadPart et CompleteMultipartUpload exécutées par le programme de chargement partitionné viades rappels transmis à son constructeur.

Importations



Exemple de code

// Create an S3Client$s3Client = new S3Client([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2006-03-01']);

// Customizing a multipart upload$source = '/path/to/large/file.zip';$uploader = new MultipartUploader($s3Client, $source, [ 'bucket' => 'your-bucket', 'key' => 'my-file.zip', 'before_initiate' => function (\Aws\Command $command) { // $command is a CreateMultipartUpload operation $command['CacheControl'] = 'max-age=3600'; }, 'before_upload' => function (\Aws\Command $command) { // $command is an UploadPart operation $command['RequestPayer'] = 'requester'; }, 'before_complete' => function (\Aws\Command $command) { // $command is a CompleteMultipartUpload operation $command['RequestPayer'] = 'requester'; },]);

222


Nettoyage de mémoire manuel entre des chargements partielsSi vous atteignez la limite de mémoire lors de chargements volumineux, c'est peut-être parce que desréférences cycliques générées par le kit SDK n'ont pas encore été traitées par le nettoyage de mémoirede PHP. L'appel manuel de l'algorithme de nettoyage entre les opérations peut permettre le traitementdes cycles avant que cette limite ne soit atteinte. L'exemple suivant appelle l'algorithme de nettoyage enutilisant un rappel avant le chargement de chaque partie. Notez que l'appel du nettoyage de mémoirereprésente un coût en termes de performances, et que l'utilisation optimale dépendra de votre casd'utilisation et de l'environnement.

$uploader = new MultipartUploader($client, $source, [ 'bucket' => 'your-bucket', 'key' => 'your-key', 'before_upload' => function(\Aws\Command $command) { gc_collect_cycles(); }]);

Récupération après erreurLorsqu'une erreur se produit au cours du processus de chargement partitionné, une exceptionMultipartUploadException est levée. Cette exception donne accès à l'objet UploadState, quicontient des informations sur la progression du chargement partitionné. L'objet UploadState peut êtreutilisé pour reprendre un chargement qui n'a pas pu aboutir.

Importations



Exemple de code


$source = '/path/to/large/file.zip';$uploader = new MultipartUploader($s3Client, $source, [ 'bucket' => 'your-bucket', 'key' => 'my-file.zip',]);

//Recover from errorsdo { try { $result = $uploader->upload(); } catch (MultipartUploadException $e) { $uploader = new MultipartUploader($s3Client, $source, [ 'state' => $e->getState(), ]); }

223




} while (!isset($result));

//Abort a multipart upload if failedtry { $result = $uploader->upload();} catch (MultipartUploadException $e) { // State contains the "Bucket", "Key", and "UploadId" $params = $e->getState()->getId(); $result = $s3Client->abortMultipartUpload($params);}

Reprendre un chargement à partir d'un objet UploadState permet de tenter de charger les parties quin'ont pas encore été chargées. L'objet d'état assure le suivi des parties manquantes, même si elles ne sesuivent pas. Le chargeur lit ou recherche dans le fichier source fourni les plages d'octets appartenant auxparties qui n'ont pas encore été chargées.

Les objets UploadState étant sérialisables, vous pouvez également reprendre un chargement dans unprocessus différent. De plus, vous pouvez récupérer l'objet UploadState, même en l'absence d'exception,en appelant la méthode $uploader->getState().

Important

Les flux transmis comme source à un MultipartUploader ne sont pas automatiquementrembobinés avant le chargement. Si vous utilisez un flux à la place d'un chemin d'accès dans uneboucle similaire à celle de l'exemple précédent, réinitialisez la variable $source à l'intérieur dubloc catch.

Importations



Exemple de code


//Using stream instead of file path$source = fopen('/path/to/large/file.zip', 'rb');$uploader = new MultipartUploader($s3Client, $source, [ 'bucket' => 'your-bucket', 'key' => 'my-file.zip',]);

do { try { $result = $uploader->upload(); } catch (MultipartUploadException $e) { rewind($source); $uploader = new MultipartUploader($s3Client, $source, [ 'state' => $e->getState(), ]); }} while (!isset($result));

224


Interruption d'un chargement partitionnéUn chargement partitionné peut être interrompu en récupérant le UploadId contenu dans l'objetUploadState et en le trnasmettant à abortMultipartUpload.

try { $result = $uploader->upload();} catch (MultipartUploadException $e) { // State contains the "Bucket", "Key", and "UploadId" $params = $e->getState()->getId(); $result = $s3Client->abortMultipartUpload($params);}

Chargements partitionnés asynchronesAppeler upload() sur le MultipartUploader constitue une demande de blocage. Si vous travaillezdans un contexte asynchrone, vous pouvez obtenir une promesse (p. 65) pour le chargement partitionné.



Exemple de code


$source = '/path/to/large/file.zip';$uploader = new MultipartUploader($s3Client, $source, [ 'bucket' => 'your-bucket', 'key' => 'my-file.zip',]);

$promise = $uploader->promise();

ConfigurationLe constructeur de l'objet MultipartUploader accepte les arguments suivants :

$client

L'objet Aws\ClientInterface à utiliser pour effectuer les transferts. Il doit s'agir d'une instance deAws\S3\S3Client.

$source

Les données source concernées par le chargement. Il peut s'agir d'un chemin d'accès ou d'une URL(par exemple, /path/to/file.jpg), d'un gestionnaire de ressources (par exemple, fopen('/path/to/file.jpg', 'r)) ou d'une instance d'un flux PSR-7.

225

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Psr.Http.Message.StreamInterface.html


$config

Un tableau associatif d'options de configuration pour le chargement partitionné.

Les options de configuration suivantes sont valides :liste acl

(string) Liste de contrôle d'accès (ACL) à définir sur l'objet concerné par le chargement. Lesobjets sont privés par défaut.

before_complete

(callable) Rappel à invoquer avant l'opération CompleteMultipartUpload. Les rappelsdoivent avoir une signature de fonction telle que function (Aws\Command $command){...}.

before_initiate

(callable) Rappel à invoquer avant l'opération CreateMultipartUpload. Les rappels doiventavoir une signature de fonction telle que function (Aws\Command $command) {...}.

before_upload

(callable) Rappel à invoquer avant toute opération UploadPart. Les rappels doivent avoir unesignature de fonction telle que function (Aws\Command $command) {...}.

bucket

(string, obligatoire) Nom du compartiment vers lequel l’objet est chargé.concurrency

(int, par défaut : int(5)) Nombre maximal d’opérations UploadPart simultanées autoriséespendant le chargement partitionné.

key

(string, obligatoire) Clé à utiliser pour l’objet concerné par le chargement.part_size

(int, par défaut : int(5242880)) Taille de partie, en octets, à utiliser lors d’un chargementpartitionné. Doit être comprise entre 5 Mo et 5 Go (inclus).

state

(Aws\Multipart\UploadState) Objet représentant l'état du chargement partitionné et utilisépour reprendre un chargement précédent. Lorsque cette option est fournie, les options bucket,key et part_size sont ignorées.

Copies partitionnéesLe kit AWS SDK for PHP inclut également un objet MultipartCopy utilisé de la même manière que leMultipartUploader, mais conçu pour la copie d’objets dont la taille est comprise entre 5 Go et 5 Todans Amazon S3.


use Aws\S3\S3Client;use Aws\Exception\AwsException;use Aws\S3\MultipartCopy;use Aws\Exception\MultipartUploadException;

Exemple de code

// Create an S3Client

226

AWS SDK pour PHP Manuel du développeurCréation de POST pré-signés S3


//Copy objects within S3$copier = new MultipartCopy($s3Client, '/bucket/key?versionId=foo', [ 'bucket' => 'your-bucket', 'key' => 'my-file.zip',]);

try { $result = $copier->copy(); echo "Copy complete: {$result['ObjectURL']}\n";} catch (MultipartUploadException $e) { echo $e->getMessage() . "\n";}

POST pré-signés Amazon S3 avec le kit AWS SDK forPHP version 3Tout comme les URL pré-signées, les POST pré-signés vous permettent de donner un accès en écritureà un utilisateur sans lui donner les informations d'identification AWS. Les formulaires POST pré-signéspeuvent être créés à l’aide d’une instance AwsS3PostObjectV4.


• obtenir des données pour un formulaire de chargement de POST d'objet S3 en utilisant PostObjectV4.



Créer une instance PostObjectV4Pour créer une instance PostObjectV4, vous devez fournir les informations suivantes :

• Instance de Aws\S3\S3Client• Compartiment• Tableau associatif des champs de saisie du formulaire• Tableau des conditions de stratégie (consultez la section Création de la stratégie dans Amazon S3

Developer Guide)• Délai d'expiration de la chaîne pour la stratégie (facultatif, une heure par défaut).

Importations


227

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.S3.PostObjectV4.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.PostObjectV4.html



https://docs.aws.amazon.com/AmazonS3/latest/dev/HTTPPOSTForms.html

AWS SDK pour PHP Manuel du développeurURL pré-signées Amazon S3


Exemple de code

$client = new S3Client([ 'profile' => 'default', 'version' => 'latest', 'region' => 'us-west-2',]);$bucket = 'mybucket';

// Set some defaults for form input fields$formInputs = ['acl' => 'public-read'];

// Construct an array of conditions for policy$options = [ ['acl' => 'public-read'], ['bucket' => $bucket], ['starts-with', '$key', 'user/eric/'],];

// Optional: configure expiration time string$expires = '+2 hours';

$postObject = new \Aws\S3\PostObjectV4( $client, $bucket, $formInputs, $options, $expires);

// Get attributes to set on an HTML form, e.g., action, method, enctype$formAttributes = $postObject->getFormAttributes();

// Get form input fields. This will include anything set as a form input in// the constructor, the provided JSON policy, your AWS access key ID, and an// auth signature.$formInputs = $postObject->getFormInputs();

URL pré-signées Amazon S3 avec le kit AWS SDK forPHP version 3Vous pouvez authentifier certains types de demandes en transférant les informations requises en tantque paramètres de la chaîne de requête au lieu d'utiliser l'en-tête HTTP Authorization. Cette méthodepermet d'activer l'accès direct d'un navigateur tiers vers vos données Amazon S3 privées sans rediriger lademande. L'idée est de créer une demande « pré-signée » et de l'encoder comme une URL récupérablepar le navigateur d'un utilisateur final. De plus, vous pouvez limiter une demande pré-signée en spécifiantun délai d'expiration.


• créer une URL pré-signée pour obtenir un objet S3 en utilisant createPresignedRequest.


228

https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.S3Client.html#_createPresignedRequest



AWS SDK pour PHP Manuel du développeurURL pré-signées Amazon S3


Création d'une demande pré-signéeVous pouvez obtenir l’URL pré-signée d’un objet Amazon S3 à l’aide de la méthode Aws\S3\S3Client::createPresignedRequest(). Cette méthode accepte un objet Aws\CommandInterface et un horodatage expiré, et renvoie un objet Psr\Http\Message\RequestInterface pré-signé. Vous pouvez récupérer l'URL pré-signée de l'objet à l'aide de la méthodegetUri() de la demande.

Le scénario le plus courant consiste à créer une URL pré-signée pour OBTENIR un objet.

Importations



Exemple de code

$s3Client = new Aws\S3\S3Client([ 'profile' => 'default', 'region' => 'us-east-2', 'version' => '2006-03-01',]);

$cmd = $s3Client->getCommand('GetObject', [ 'Bucket' => 'my-bucket', 'Key' => 'testKey']);

$request = $s3Client->createPresignedRequest($cmd, '+20 minutes');

Création d'une URL pré-signéeVous pouvez créer des URL pré-signées pour n’importe quelle opération Amazon S3 en utilisant laméthode getCommand permettant de créer un objet de commande, puis en appelant la méthodecreatePresignedRequest() avec la commande. Lors de l'envoi final de la demande, veillez à utiliser lamême méthode et les mêmes en-têtes que ceux de la demande renvoyée.

Exemple de code

//Creating a presigned URL$cmd = $s3Client->getCommand('GetObject', [ 'Bucket' => 'my-bucket', 'Key' => 'testKey']);

$request = $s3Client->createPresignedRequest($cmd, '+20 minutes');

// Get the actual presigned-url$presignedUrl = (string)$request->getUri();

229

AWS SDK pour PHP Manuel du développeurUtilisation d’un compartiment Amazon

S3 en tant qu’hôte Web statique

Obtention de l'URL d'un objetSi vous avez uniquement besoin de l’URL publique d’un objet stocké dans un compartiment Amazon S3,vous pouvez utiliser la méthode Aws\S3\S3Client::getObjectUrl(). Cette méthode renvoie uneURL non signée au compartiment et à la clé fournis.

Exemple de code

//Getting the URL to an object$url = $s3Client->getObjectUrl('my-bucket', 'my-key');

Important

L'URL renvoyée par cette méthode n'est pas validée pour garantir l'existence du compartiment oude la clé, et cette méthode ne garantit pas non plus que l'objet autorise un accès non authentifié.

Utilisation d’un compartiment Amazon S3 en tantqu’hôte Web statique avec le kit AWS SDK for PHPversion 3Vous pouvez héberger un site Web statique sur Amazon S3. Pour en savoir plus, consultez la sectionHébergement d’un site Web statique sur S3.


• Obtenir la configuration de site Web d’un compartiment à l’aide de GetBucketWebsite.• Définir la configuration de site Web d’un compartiment à l’aide de PutBucketWebsite.• Supprimer la configuration de site Web d’un compartiment à l’aide de DeleteBucketWebsite.


Informations d'identificationAvant d'exécuter l'exemple de code, configurez vos informations d'identification AWS. Consultez la sectionInformations d’identification pour le kit AWS SDK pour PHP version 3 (p. 42).

Obtenir, définir et supprimer la configuration de site Web d'uncompartimentImportations



Exemple de code

$s3Client = new S3Client([ 'profile' => 'default', 'region' => 'us-west-2',

230

https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketwebsite

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketwebsite

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#deletebucketwebsite



AWS SDK pour PHP Manuel du développeurUtilisation de stratégies de compartiment Amazon S3

'version' => '2006-03-01']);

// Retrieving the Bucket Website Configuration$bucket = 'my-s3-bucket';try { $resp = $s3Client->getBucketWebsite([ 'Bucket' => $bucket ]); echo "Succeed in retrieving website configuration for bucket: " . $bucket . "\n";} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

// Setting a Bucket Website Configuration$params = [ 'Bucket' => $bucket, 'WebsiteConfiguration' => [ 'ErrorDocument' => [ 'Key' => 'foo', ], 'IndexDocument' => [ 'Suffix' => 'bar', ], ]];

try { $resp = $s3Client->putBucketWebsite($params); echo "Succeed in setting bucket website configuration.\n";} catch (AwsException $e) { // Display error message echo $e->getMessage(); echo "\n";}

// Deleting a Bucket Website Configurationtry { $resp = $s3Client->deleteBucketWebsite([ 'Bucket' => $bucket ]); echo "Succeed in deleting policy for bucket: " . $bucket . "\n";} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Utilisation de stratégies de compartiment Amazon S3avec le kit AWS SDK pour PHP version 3Vous pouvez utiliser une stratégie de compartiment pour accorder des autorisations à vos ressourcesAmazon S3. Pour en savoir plus, consultez Utilisation de stratégies de compartiment et de stratégiesutilisateur.


• Renvoyer la stratégie pour un compartiment spécifié à l’aide de GetBucketPolicy.

231

https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html

https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketpolicy

AWS SDK pour PHP Manuel du développeurUtilisation de stratégies de compartiment Amazon S3

• Remplacer une stratégie sur un compartiment à l’aide de PutBucketPolicy.• Supprimer une stratégie d’un compartiment à l’aide de DeleteBucketPolicy.



Obtenir, supprimer et remplacer une stratégie sur uncompartimentImportations

require "vendor/autoload.php";


Exemple de code


$bucket = 'my-s3-bucket';

// Get the policy of a specific buckettry { $resp = $s3Client->getBucketPolicy([ 'Bucket' => $bucket ]); echo "Succeed in receiving bucket policy:\n"; echo $resp->get('Policy'); echo "\n";} catch (AwsException $e) { // Display error message echo $e->getMessage(); echo "\n";}

// Deletes the policy from the buckettry { $resp = $s3Client->deleteBucketPolicy([ 'Bucket' => $bucket ]); echo "Succeed in deleting policy of bucket: " . $bucket . "\n";} catch (AwsException $e) { // Display error message echo $e->getMessage(); echo "\n";}

232

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketpolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#deletebucketpolicy



AWS SDK pour PHP Manuel du développeurAmazon Secrets Manager

// Replaces a policy on the buckettry { $resp = $s3Client->putBucketPolicy([ 'Bucket' => $bucket, 'Policy' => 'foo policy', ]); echo "Succeed in put a policy on bucket: " . $bucket . "\n";} catch (AwsException $e) { // Display error message echo $e->getMessage(); echo "\n";}

Gestion des secrets à l'aide de l'API SecretsManager et du kit AWS SDK for PHP version 3

AWS Secrets Manager stocke et gère les secrets partagés tels que les mots de passe, les clés d'API etles informations d'identification de bases de données. Avec le service Secrets Manager, les développeurspeuvent remplacer les informations d'identification codées en dur dans le code déployé par un appelintégré à Secrets Manager.

Secrets Manager prend en charge, de manière native, la rotation planifiée automatique des informationsd'identification pour les bases de données Amazon Relational Database Service (Amazon RDS), ce quirenforce la sécurité des applications. Secrets Manager peut également effectuer, de manière transparente,une rotation des secrets pour d'autres bases de données et services tiers en utilisant AWS Lambda pourmettre en œuvre des détails propres au service.


• Créer un secret en utilisant CreateSecret.• Récupérer un secret en utilisant GetSecretValue.• Répertorier tous les secrets stockés par Secrets Manager en utilisant ListSecrets.• Obtenir les détails d'un secret en utilisant DescribeSecret.• Mettre à jour un secret en utilisant PutSecretValue.• Configurer une rotation de secrets en utilisant RotateSecret.• Marquer un secret en vue de sa suppression en utilisant DeleteSecret.



Créer un secret dans Secrets ManagerPour créer un secret dans Secrets Manager, utilisez l'opération CreateSecret.

233

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#createsecret

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#getsecretvalue

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#listsecrets

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#describesecret

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#putsecretvalue

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#deletesecret



https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#createsecret

AWS SDK pour PHP Manuel du développeurRécupérer un secret à partir d'Secrets Manager

Dans cet exemple, un nom d'utilisateur et un mot de passe sont stockés sous forme de chaîne JSON.

Importations


use Aws\SecretsManager\SecretsManagerClient; use Aws\Exception\AwsException;

Exemple de code

$client = new SecretsManagerClient([ 'profile' => 'default', 'version' => '2017-10-17', 'region' => 'us-west-2']);

$secretName = '<<{{MySecretName}}>>';$secret = '{"username":"<<USERNAME>>","password":"<<PASSWORD>>"}';$description = '<<Description>>';

try { $result = $client->createSecret([ 'Description' => $description, 'Name' => $secretName, 'SecretString' => $secret, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Récupérer un secret à partir d'Secrets ManagerPour récupérer la valeur d'un secret stocké dans Secrets Manager, utilisez l'opération GetSecretValue.

Dans cet exemple, le secret est une chaîne contenant la valeur stockée. Si l'appel est émis sur le secretque nous avons créé précédemment, cet exemple génère [{\"username\":\"<<USERNAME>>\",\"password\":\"<<PASSWORD>>\"}]. Utilisez json.loads pour accéder aux valeurs indexées.

Importations



Exemple de code

$client = new SecretsManagerClient([ 'profile' => 'default', 'version' => '2017-10-17', 'region' => '<<{{MyRegionName}}>>',]);

234

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#getsecretvalue

AWS SDK pour PHP Manuel du développeurRépertorier les secrets stockés dans Secrets Manager

$secretName = '<<{{MySecretName}}>>';

try { $result = $client->getSecretValue([ 'SecretId' => $secretName, ]);

} catch (AwsException $e) { $error = $e->getAwsErrorCode(); if ($error == 'DecryptionFailureException') { // Secrets Manager can't decrypt the protected secret text using the provided AWS KMS key. // Handle the exception here, and/or rethrow as needed. throw $e; } if ($error == 'InternalServiceErrorException') { // An error occurred on the server side. // Handle the exception here, and/or rethrow as needed. throw $e; } if ($error == 'InvalidParameterException') { // You provided an invalid value for a parameter. // Handle the exception here, and/or rethrow as needed. throw $e; } if ($error == 'InvalidRequestException') { // You provided a parameter value that is not valid for the current state of the resource. // Handle the exception here, and/or rethrow as needed. throw $e; } if ($error == 'ResourceNotFoundException') { // We can't find the resource that you asked for. // Handle the exception here, and/or rethrow as needed. throw $e; }}// Decrypts secret using the associated KMS CMK.// Depending on whether the secret is a string or binary, one of these fields will be populated.if (isset($result['SecretString'])) { $secret = $result['SecretString'];} else { $secret = base64_decode($result['SecretBinary']);}

// Your code goes here;

Répertorier les secrets stockés dans Secrets ManagerObtenez une liste de tous les secrets stockés dans Secrets Manager en utilisant l'opération ListSecrets.

Importations



Exemple de code

235

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#listsecrets

AWS SDK pour PHP Manuel du développeurObtenir les détails d'un secret


try { $result = $client->listSecrets([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Obtenir les détails d'un secretLes secrets stockés contiennent des métadonnées relatives aux règles de rotation, aux derniers accèsou aux dernières modifications dont ils on fait l'objet, aux balises créées par les utilisateurs, sans oublierl'Amazon Resource Name (ARN). Pour obtenir les détails d'un secret stocké dans Secrets Manager, utilisezl'opération DescribeSecret.

Importations



Exemple de code



try { $result = $client->describeSecret([ 'SecretId' => $secretName, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Mettre à jour la valeur d'un secretPour stocker une nouvelle valeur secrète chiffrée dans Secrets Manager, utilisez l'opérationPutSecretValue.

236

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#describesecret

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#putsecretvalue

AWS SDK pour PHP Manuel du développeurConfigurer la rotation de la valeurd'un secret dans Secrets Manager

Cette opération crée une nouvelle version du secret. Si une version du secret existe déjà, ajoutez leparamètre VersionStages avec la valeur dans AWSCURRENT pour que la nouvelle valeur soit utilisée lorsde la récupération de la valeur.

Importations



Exemple de code


$secretName = '<<{{MySecretName}}>>';$secret = '{"username":"<<USERNAME>>","password":"<<PASSWORD>>"}';

try { $result = $client->putSecretValue([ 'SecretId' => $secretName, 'SecretString' => $secret, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Configurer la rotation de la valeur d'un secret dansSecrets ManagerPour configurer la rotation de la valeur d'un secret stocké dans Secrets Manager, utilisez une fonction derotation Lambda et l'opération RotateSecret.

Avant de commencer, créez une fonction Lambda pour configurer la rotation du secret. Le catalogued'exemples de code AWS contient actuellement plusieurs exemples de code Lambda permettant deconfigurer la rotation des informations d'identification de bases de données Amazon RDS.

Note

Pour plus d'informations sur la rotation des secrets, consultez la section Rotation de vos secretsAWS Secrets Manager du AWS Secrets Manager User Guide.

Après avoir configuré votre fonction Lambda, configurez une nouvelle rotation de secret.

Importations


237


https://docs.aws.amazon.com/code-samples/latest/catalog/code-catalog-lambda_functions-secretsmanager.html

https://docs.aws.amazon.com/code-samples/latest/catalog/code-catalog-lambda_functions-secretsmanager.html

https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html

https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html

AWS SDK pour PHP Manuel du développeurConfigurer la rotation de la valeurd'un secret dans Secrets Manager


Exemple de code


$secretName = '<<{{MySecretName}}>>';$lambda_ARN = 'arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda';$rules = ['AutomaticallyAfterDays' => 30];

try { $result = $client->rotateSecret([ 'RotationLambdaARN' => $lambda_ARN, 'RotationRules' => $rules, 'SecretId' => $secretName, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Lorsqu'une rotation est configurée, vous pouvez mettre en œuvre une rotation à l'aide de l'opérationRotateSecret.

Importations



Exemple de code



try { $result = $client->rotateSecret([ 'SecretId' => $secretName, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

238


AWS SDK pour PHP Manuel du développeurSupprimer un secret d'Secrets Manager

Supprimer un secret d'Secrets ManagerPour supprimer un secret d'Secrets Manager, utilisez l'opération DeleteSecret. Pour éviter toutesuppression accidentelle d'un secret, un horodatage DeletionDate est automatiquement ajouté au secret.Il spécifie une fenêtre de récupération pendant laquelle vous pouvez annuler la suppression. Si aucunedurée n'est spécifiée pour la fenêtre de récupération, la durée par défaut est de 30 jours.

Importations



Exemple de code



try { $result = $client->deleteSecret([ 'SecretId' => $secretName, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Informations connexesLes exemples du kit AWS SDK for PHP utilisent les opérations REST suivantes de l'AWS Secrets ManagerAPI Reference :

• CreateSecret• GetSecretValue• ListSecrets• DescribeSecret• PutSecretValue• RotateSecret• DeleteSecret

Pour plus d'informations sur l'utilisation d'AWS Secrets Manager, consultez le Guide de l'utilisateur d'AWSSecrets Manager.

239

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#deletesecret

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_ListSecrets.html

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DescribeSecret.html

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_PutSecretValue.html

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html

https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html

https://docs.aws.amazon.com/secretsmanager/latest/userguide/

https://docs.aws.amazon.com/secretsmanager/latest/userguide/

AWS SDK pour PHP Manuel du développeurExemples Amazon SES

Exemples Amazon SES avec le kit AWS SDK forPHP version 3

Amazon Simple Email Service (Amazon SES) est une plateforme de messagerie qui vous offre un moyensimple et économique d'envoyer et de recevoir du courrier électronique en utilisant vos propres adresses e-mail et domaines. Pour plus d’informations sur Amazon SES, consultez le Manuel du développeur AmazonSES.


Rubriques• Vérification des identités des e-mails à l’aide de l’API Amazon SES et du kit AWS SDK for PHP

version 3 (p. 240)• Création de modèles d’e-mail personnalisés à l’aide de l’API Amazon SES et du kit AWS SDK for PHP

version 3 (p. 245)• Gestion des filtres d’e-mails à l’aide de l’API Amazon SES et du kit AWS SDK for PHP

version 3 (p. 249)• Création et gestion des règles d’e-mail à l’aide de l’API Amazon SES et du kit AWS SDK for PHP

version 3 (p. 252)• Surveillance de votre activité d’envoi à l’aide de l’API Amazon SES et du kit AWS SDK for PHP

version 3 (p. 258)• Autoriser les expéditeurs à l’aide de l’API Amazon SES et du kit AWS SDK for PHP version 3 (p. 259)

Vérification des identités des e-mails à l’aide de l’APIAmazon SES et du kit AWS SDK for PHP version 3Lorsque vous commencez à utiliser votre compte Amazon Simple Email Service (Amazon SES), tous lesexpéditeurs et les destinataires doivent être vérifiés dans la même région AWS que celle à laquelle vousenvoyez des e-mails. Pour plus d’informations sur l’envoi d’e-mails, consultez la section Envoi d’e-mailsavec Amazon SES.


• Vérifier une adresse e-mail à l’aide de VerifyEmailIdentity.• Vérifier un domaine d’e-mail à l’aide de VerifyDomainIdentity.• Répertorier toutes les adresses e-mail à l’aide de ListIdentities.• Répertorier tous les domaines d’e-mail à l’aide de ListIdentities.

240

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/




https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-email.html

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-email.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifyemailidentity

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifydomainidentity

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities

AWS SDK pour PHP Manuel du développeurVérification des adresses e-mail

• Supprimer une adresse e-mail à l’aide de DeleteIdentity.• Supprimer un domaine d’e-mail à l’aide de DeleteIdentity.



Pour plus d’informations sur l’utilisation d’Amazon SES, consultez le Manuel du développeur Amazon SES.

Vérification des adresses e-mailAmazon SES peut envoyer un e-mail uniquement partir d’adresses e-mail ou de domaines vérifiés. Envérifiant une adresse e-mail, vous démontrez que vous êtes le propriétaire de cette adresse et que voussouhaitez autoriser Amazon SES à envoyer des e-mails à partir de cette adresse.

Lorsque vous exécutez l’exemple de code suivant, Amazon SES envoie un e-mail à l’adresse que vousavez indiquée. Lorsque vous (ou le destinataire de l’e-mail) cliquez sur le lien dans l’e-mail, l’adresse estvérifiée.

Pour ajouter une adresse e-mail à votre compte Amazon SES, utilisez l’opération VerifyEmailIdentity.

Importations


use Aws\Ses\SesClient; use Aws\Exception\AwsException;

Exemple de code

$SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2']);

$email = 'email_address';

try { $result = $SesClient->verifyEmailIdentity([ 'EmailAddress' => $email, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

241

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity




https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyEmailIdentity.html


Vérifier un domaine d’e-mailAmazon SES peut envoyer un e-mail uniquement partir d’adresses e-mail ou de domaines vérifiés. Envérifiant un domaine, vous démontrez que vous êtes le propriétaire de ce domaine. Lorsque vous vérifiezun domaine, vous permettez à Amazon SES d’envoyer des e-mails à partir de n’importe quelle adresse surce domaine.

Lorsque vous exécutez l’exemple de code suivant, Amazon SES vous fournit un jeton de vérification. Vousdevez ajouter le jeton à la configuration DNS de votre domaine. Pour plus d’informations, consultez lasection Vérification d’un domaine avec Amazon SES dans le Amazon SES Developer Guide.

Pour ajouter un domaine d’expédition à votre compte Amazon SES, utilisez l’opérationVerifyDomainIdentity.

Importations



Exemple de code


$domain = 'domain.name';

try { $result = $SesClient->verifyDomainIdentity([ 'Domain' => $domain, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier des adresses e-mailPour récupérer une liste des adresses e-mail présentées dans la région AWS actuelle, quel que soit l’étatde vérification, utilisez l’opération ListIdentities.

Importations



Exemple de code

242

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyDomainIdentity.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html



try { $result = $SesClient->listIdentities([ 'IdentityType' => 'EmailAddress', ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier les domaines d’e-mailPour récupérer une liste des domaines d’e-mail présentés dans la région AWS actuelle, quel que soit l’étatde vérification, utilisez l’opération ListIdentities.

Importations



Exemple de code


try { $result = $SesClient->listIdentities([ 'IdentityType' => 'Domain', ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer une adresse e-mailPour supprimer une adresse e-mail vérifiée de la liste des identités, utilisez l’opération DeleteIdentity.

Importations

243

https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html




Exemple de code


$email = 'email_address';

try { $result = $SesClient->deleteIdentity([ 'Identity' => $email, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer un domaine d’e-mailPour supprimer un domaine d’e-mail vérifié de la liste des identités vérifiées, utilisez l’opérationDeleteIdentity.

Importations



Exemple de code


$domain = 'domain.name';

try { $result = $SesClient->deleteIdentity([ 'Identity' => $domain, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

244

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html

AWS SDK pour PHP Manuel du développeurUtilisation des modèles d’e-mail

Création de modèles d’e-mail personnalisés à l’aidede l’API Amazon SES et du kit AWS SDK for PHPversion 3Amazon Simple Email Service (Amazon SES) vous permet d’envoyer des e-mails personnalisés à chaquedestinataire en utilisant des modèles. Les modèles incluent une ligne d’objet, ainsi que les parties texte etHTML du corps de l’e-mail. Les sections objet et corps peuvent également contenir des valeurs uniquespersonnalisées pour chaque destinataire.

Pour plus d’informations, consultez la section Envoi d’e-mails personnalisés à l’aide d’Amazon SES dans leAmazon SES Developer Guide.


• Créer un modèle d’e-mail à l’aide de CreateTemplate.• Répertorier tous les modèles d’e-mail à l’aide de ListTemplates.• Récupérer un modèle d’e-mail à l’aide de GetTemplate.• Mettre à jour un modèle d’e-mail à l’aide de UpdateTemplate.• Supprimer un modèle d’e-mail à l’aide de DeleteTemplate.• Envoyer un e-mail basé sur un modèle à l’aide de SendTemplatedEmail.




Créer un modèle d’e-mailPour créer un modèle d’envoi d’e-mails personnalisés, utilisez l’opération CreateTemplate. Le modèle peutêtre utilisé par n’importe quel compte autorisé à envoyer des messages dans la région AWS dans laquellele modèle est ajouté.

Note

Amazon SES ne valide pas vos HTML. Vérifiez donc que HtmlPart est valide avant d'envoyer une-mail.

Importations



Exemple de code

245

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createtemplate

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listtemplates

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#gettemplate

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updateTemplate

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletetemplate

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#sendtemplatedemail




https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateTemplate.html



$name = 'Template_Name';$html_body = '<h1>AWS Amazon Simple Email Service Test Email</h1>' . '<p>This email was sent with <a href="https://aws.amazon.com/ses/">' . 'Amazon SES</a> using the <a href="https://aws.amazon.com/sdk-for-php/">' . 'AWS SDK for PHP</a>.</p>';$subject = 'Amazon SES test (AWS SDK for PHP)';$plaintext_body = 'This email was send with Amazon SES using the AWS SDK for PHP.';

try { $result = $SesClient->createTemplate([ 'Template' => [ 'HtmlPart' => $html_body, 'SubjectPart' => $subject, 'TemplateName' => $name, 'TextPart' => $plaintext_body, ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Obtenir un modèle d’e-mailPour afficher le contenu d’un modèle d’e-mail existant, avec la ligne d’objet, le corps au format HTML et letexte brut, utilisez l’opération GetTemplate. Seul TemplateName est obligatoire.

Importations



Exemple de code


$name = 'Template_Name';

try { $result = $SesClient->getTemplate([ 'TemplateName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails

246

https://docs.aws.amazon.com/ses/latest/APIReference/API_GetTemplate.html


echo $e->getMessage(); echo "\n";}

Répertorier tous les modèles d’e-mailPour récupérer une liste de tous les modèles d’e-mail associés à votre compte AWS dans la région AWSactuelle, utilisez l’opération ListTemplates.

Importations



Exemple de code


try { $result = $SesClient->listTemplates([ 'MaxItems' => 10, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Mettre à jour un modèle d’e-mailPour modifier le contenu d’un modèle d’e-mail spécifique, avec la ligne d’objet, le corps au format HTML etle texte brut, utilisez l’opération UpdateTemplate.

Importations



Exemple de code


247

https://docs.aws.amazon.com/ses/latest/APIReference/API_ListTemplates.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdadteTemplate.html


$name = 'Template_Name';$html_body = '<h1>AWS Amazon Simple Email Service Test Email</h1>' . '<p>This email was sent with <a href="https://aws.amazon.com/ses/">' . 'Amazon SES</a> using the <a href="https://aws.amazon.com/sdk-for-php/">' . 'AWS SDK for PHP</a>.</p>';$subject = 'Amazon SES test (AWS SDK for PHP)';$plaintext_body = 'This email was send with Amazon SES using the AWS SDK for PHP.';

try { $result = $SesClient->updateTemplate([ 'Template' => [ 'HtmlPart' => $html_body, 'SubjectPart' => $subject, 'TemplateName' => $name, 'TextPart' => $plaintext_body, ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer un modèle d’e-mailPour supprimer un modèle d’e-mail spécifique, utilisez l’opération DeleteTemplate. TemplateName est toutce dont vous avez besoin.

Importations



Exemple de code


$name = 'Template_Name';

try { $result = $SesClient->deleteTemplate([ 'TemplateName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

248

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteTemplate.html

AWS SDK pour PHP Manuel du développeurGestion des filtres d’e-mails

Envoyer un e-mail avec un modèlePour utiliser un modèle pour envoyer un e-mail aux destinataires, utilisez l’opération SendTemplateEmail.

Importations



Exemple de code


$template_name = 'Template_Name';$sender_email = 'email_address';$recipient_emails = ['email_address'];

try { $result = $SesClient->sendTemplatedEmail([ 'Destination' => [ 'ToAddresses' => $verified_recipient_emails, ], 'ReplyToAddresses' => [$sender_email], 'Source' => $sender_email,

'Template' => $template_name, 'TemplateData' => '{ }' ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Gestion des filtres d’e-mails à l’aide de l’API AmazonSES et du kit AWS SDK for PHP version 3Outre l’envoi des e-mails, vous pouvez également recevoir des e-mails avec Amazon Simple Email Service(Amazon SES). Un filtre d’adresses IP vous permet, le cas échéant, de choisir d’accepter ou de rejeter lesmessages provenant d’une adresse IP ou d’une plage d’adresses IP. Pour plus d’informations, consultez lasection Gestion des filtres d’adresses IP pour la réception d’e-mails via Amazon SES.


• Créer un filtre d’e-mails à l’aide de CreateReceiptFilter.• Lire tous les filtres d’e-mails à l’aide de ListReceiptFilters.• Supprimer un filtre d’e-mails à l’aide de DeleteReceiptFilter.

249

https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptfilter

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptfilters

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptfilter





Créer un filtre d’e-mailsPour autoriser ou bloquer des e-mails provenant d’une adresse IP spécifique, utilisez l’opérationCreateReceiptFilter. Indiquez l’adresse IP ou la plage d’adresses et un nom unique pour identifier ce filtre.

Importations



Exemple de code


$filter_name = 'FilterName';$ip_address_range = '10.0.0.1/24';

try { $result = $SesClient->createReceiptFilter([ 'Filter' => [ 'IpFilter' => [ 'Cidr' => $ip_address_range, 'Policy' => 'Block|Allow', ], 'Name' => $filter_name, ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier tous les filtres d’e-mailsPour répertorier les filtres d’adresses IP associés à votre compte AWS dans la région AWS actuelle, utilisezl’opération ListReceiptFilters.

Importations

250




https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptFilter.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptFilters.html




Exemple de code


try { $result = $SesClient->listReceiptFilters([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer un filtre d’e-mailsPour supprimer un filtre existant pour une adresse IP spécifique, utilisez l’opération DeleteReceiptFilter.Indiquez un nom de filtre unique pour identifier le filtre de réception à supprimer.

Si vous avez besoin de modifier la plage des adresses filtrées, vous pouvez supprimer un filtre de réceptionet en créer un nouveau.

Importations



Exemple de code


$filter_name = 'FilterName';

try { $result = $SesClient->deleteReceiptFilter([ 'FilterName' => $filter_name,

]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage();

251

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptFilter.html

AWS SDK pour PHP Manuel du développeurUtilisation des règles d’e-mail

echo "\n";}

Création et gestion des règles d’e-mail à l’aide de l’APIAmazon SES et du kit AWS SDK for PHP version 3Outre l’envoi des e-mails, vous pouvez également recevoir des e-mails avec Amazon Simple Email Service(Amazon SES). Les règles de réception vous permettent d’indiquer ce qu’Amazon SES fait avec les e-mailsqu’il reçoit pour les adresses e-mail et les domaines que vous possédez. Une règle peut envoyer des e-mails à d’autres services AWS, y compris, sans toutefois s’y limiter, Amazon S3, Amazon SNS ou AWSLambda.

Pour plus d’informations, consultez la section Gestion des ensembles de règles de réception pour recevoirles e-mails Amazon SES et Gestion des règles de réception pour recevoir les e-mails Amazon SES.


• Créer un ensemble de règles de réception à l’aide de CreateReceiptRuleSet.• Créer une règle de réception à l’aide de CreateReceiptRule.• Décrire un ensemble de règles de réception à l’aide de DescribeReceiptRuleSet.• Décrire une règle de réception à l’aide de DescribeReceiptRule.• Répertorier tous les ensembles de règles de réception à l’aide de ListReceiptRuleSets.• Mettre à jour une règle de réception à l’aide de UpdateReceiptRule.• Supprimer une règle de réception à l’aide de DeleteReceiptRule.• Supprimer un ensemble de règles de réception à l’aide de DeleteReceiptRuleSet.




Créer un ensemble de règles de réceptionUn ensemble de règles de réception renfermer plusieurs règles de réception. Au moins un ensemble derègles de réception doit être associé à votre compte avant de pouvoir créer une règle de réception. Pourcréer un ensemble de règles de réception, fournissez un nom RuleSetName unique et utilisez l’opérationCreateReceiptRuleSet.

Importations



252

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptruleset

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptrule

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptruleset

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptrule

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptrulesets

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updatereceiptrule

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptrule

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptruleset




https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRuleSet.html


Exemple de code


$name = 'Rule_Set_Name';

try { $result = $SesClient->createReceiptRuleSet([ 'RuleSetName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Créer une règle de réceptionContrôlez vos e-mails entrants en ajoutant une règle de réception à un ensemble de règles de réceptionexistant. Cet exemple montre comment créer une règle de réception qui envoie des messages entrantsà un compartiment Amazon S3. Vous pouvez cependant également envoyer des messages à AmazonSNS et AWS Lambda. Pour créer une règle de réception, indiquez une règle et le nom RuleSetName àl’opération CreateReceiptRule.

Importations



Exemple de code


$rule_name = 'Rule_Name';$rule_set_name = 'Rule_Set_Name';$s3_bucket = 'Bucket_Name';

try { $result = $SesClient->createReceiptRule([ 'Rule' => [ 'Actions' => [ [ 'S3Action' => [ 'BucketName' => $s3_bucket, ], ], ],

253

https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html


'Name' => $rule_name, 'ScanEnabled' => true, 'TlsPolicy' => 'Optional', 'Recipients' => ['<string>', ...] ], 'RuleSetName' => $rule_set_name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Décrire un ensemble de règles de réceptionUne fois par seconde, renvoie les détails de l’ensemble de règles de réception spécifié. Pour utiliserl’opération DescribeReceiptRuleSet, indiquez le nom RuleSetName.

Importations



Exemple de code



try { $result = $SesClient->describeReceiptRuleSet([ 'RuleSetName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Décrire une règle de réceptionRenvoie les détails d’une règle de réception spécifiée. Pour utiliser l’opération DescribeReceiptRule,indiquez le nom RuleName et RuleSetName.

Importations

254

https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRuleSet.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRule.html




Exemple de code


$rule_name = 'Rule_Name';$rule_set_name = 'Rule_Set_Name';

try { $result = $SesClient->describeReceiptRule([ 'RuleName' => $rule_name, 'RuleSetName' => $rule_set_name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Répertorier tous les ensembles de règles de réceptionPour répertorier les ensembles de règles de réception qui existent dans votre compte AWS dans la régionAWS actuelle, utilisez l’opération ListReceiptRuleSets.

Importations



Exemple de code


try { $result = $SesClient->listReceiptRuleSets([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

255

https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptRuleSets.html


Mettre à jour une règle de réceptionCet exemple montre comment mettre à jour une règle de réception qui envoie des messages entrants àune fonction AWS Lambda. Vous pouvez cependant également envoyer des messages à Amazon SNS etAmazon S3. Pour utiliser l’opération UpdateReceiptRule, indiquez la nouvelle règle de réception et le nomRuleSetName.

Importations



Exemple de code


$rule_name = 'Rule_Name';$rule_set_name = 'Rule_Set_Name';$lambda_arn = 'Amazon Resource Name (ARN) of the AWS Lambda function';$sns_topic_arn = 'Amazon Resource Name (ARN) of the Amazon SNS topic';

try { $result = $SesClient->updateReceiptRule([ 'Rule' => [ 'Actions' => [ 'LambdaAction' => [ 'FunctionArn' => $lambda_arn, 'TopicArn' => $sns_topic_arn, ], ], 'Enabled' => true, 'Name' => $rule_name, 'ScanEnabled' => false, 'TlsPolicy' => 'Require', ], 'RuleSetName' => $rule_set_name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer un ensemble de règles de réceptionSupprimez un ensemble de règles de réception qui n'est pas actuellement désactivé. Cette opérationsupprime également toutes les règles de réception qu’il contient. Pour supprimer un ensemble de règles deréception, indiquez le nom RuleSetName à l’opération DeleteReceiptRuleSet.

256

https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateReceiptRule.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRuleSet.html


Importations



Exemple de code



try { $result = $SesClient->deleteReceiptRuleSet([ 'RuleSetName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Supprimer une règle de réceptionPour supprimer une règle de réception spécifiée, indiquez le nom RuleName et RuleSetName à l’opérationDeleteReceiptRule.

Importations



Exemple de code


$rule_name = 'Rule_Name';$rule_set_name = 'Rule_Set_Name';

try { $result = $SesClient->deleteReceiptRule([ 'RuleName' => $rule_name, 'RuleSetName' => $rule_set_name, ]);

257

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRule.html

AWS SDK pour PHP Manuel du développeurSurveiller votre activité d’envoi


Surveillance de votre activité d’envoi à l’aide de l’APIAmazon SES et du kit AWS SDK for PHP version 3Amazon Simple Email Service (Amazon SES) fournit des méthodes de surveillance de votre activitéd’envoi. Nous vous recommandons d'implémenter ces méthodes afin d'assurer le suivi des métriquesimportantes, telles que les taux de retours à l'expéditeur, de réclamations et de rejets. Des taux trop élevésde retours à l’expéditeur et de réclamations peuvent compromettre votre capacité à envoyer des e-mails àl’aide d’Amazon SES.


• Vérifier votre quota d’envoi à l’aide de GetSendQuota.• Surveiller votre activité d’envoi à l’aide de GetSendStatistics.




Vérifier votre quota d’envoiVous ne pouvez envoyer qu’une certaine quantité de messages sur une période de 24 heures. Pour vérifierle nombre de messages que vous êtes toujours autorisé à envoyer, utilisez l’opération GetSendQuota. Pourplus d’informations, consultez la section Gestion de vos limites d’envoi Amazon SES.

Importations



Exemple de code

$SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1'

258

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendquota

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendstatistics




https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendQuota.html

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html

AWS SDK pour PHP Manuel du développeurAutoriser les expéditeurs

]);

try { $result = $SesClient->getSendQuota([ ]); $send_limit = $result["Max24HourSend"]; $sent = $result["SentLast24Hours"]; $available = $send_limit - $sent; print("<p>You can send " . $available . " more messages in the next 24 hours.</p>"); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Surveiller votre activité d’envoiPour récupérer les métriques des messages que vous avez envoyés au cours des deux dernièressemaines, utilisez l'opération GetSendStatistics. Cet exemple renvoie le nombre de tentatives d’envoi, deretours à l’expéditeur, de réclamations et de messages rejetés par tranche de 15 minutes.

Importations



Exemple de code

$SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1']);

try { $result = $SesClient->getSendStatistics([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Autoriser les expéditeurs à l’aide de l’API AmazonSES et du kit AWS SDK for PHP version 3Pour permettre à un autre compte AWS, un utilisateur AWS Identity and Access Management ou un serviceAWS à envoyer des e-mails via Amazon Simple Email Service (Amazon SES) en votre nom, créez unestratégie d’autorisation d’envoi. Il s’agit d’un document JSON que vous attachez à une identité dont vousêtes propriétaire.

259

https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendStatistics.html


La stratégie mentionne expressément les entités que vous autorisez à effectuer des envois pour cetteidentité, ainsi que les conditions associées. Tous les expéditeurs, autres que vous et les entités auxquellesvous accordez explicitement des autorisations dans la stratégie, ne sont pas autorisés à envoyer des e-mails. Une identité peut avoir zéro, une ou plusieurs stratégies attachées. Une stratégie peut égalementcontenir plusieurs instructions pour produire l'effet de plusieurs stratégies.

Pour plus d’informations, consultez la page Utilisation de l’autorisation d’envoi avec Amazon SES.


• Créer un expéditeur autorisé à l’aide de PutIdentityPolicy.• Récupérer des stratégies pour un expéditeur autorisé à l’aide de GetIdentityPolicies.• Répertorier les expéditeurs autorisés à l’aide de ListIdentityPolicies.• Révoquer l’autorisation d’un expéditeur autorisé à l’aide de DeleteIdentityPolicy.




Créer un expéditeur autoriséPour autoriser un autre compte AWS à envoyer des e-mails en votre nom, utilisez une stratégie d’identitépour ajouter ou mettre à jour l’autorisation d’envoi d’e-mails depuis vos adresses électroniques oudomaines vérifiés. Pour créer une stratégie d’identité, utilisez l’opération PutIdentityPolicy.

Importations



Exemple de code


$identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com";$other_aws_account = "0123456789";$policy = <<<EOT{ "Id":"ExampleAuthorizationPolicy", "Version":"2012-10-17", "Statement":[ {

260

https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createidentitypolicy

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getidentitypolicies

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentitypolicies

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentitypolicy




https://docs.aws.amazon.com/ses/latest/APIReference/API_PutIdentityPolicy.html


"Sid":"AuthorizeAccount", "Effect":"Allow", "Resource":"$identity", "Principal":{ "AWS":[ "$other_aws_account" ] }, "Action":[ "SES:SendEmail", "SES:SendRawEmail" ] } ]}EOT;$name = "policyName";

try { $result = $SesClient->putIdentityPolicy([ 'Identity' => $identity, 'Policy' => $policy, 'PolicyName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Récupérer des stratégies pour un expéditeur autoriséRenvoyez les stratégies d’autorisation d’envoi associées à une identité d’e-mail spécifique ou à une identitéde domaine. Pour obtenir l’autorisation d’envoi pour une adresse e-mail ou un domaine, utilisez l’opérationGetIdentityPolicy.

Importations



Exemple de code


$identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com";$policies = ["policyName"];

try { $result = $SesClient->getIdentityPolicies([ 'Identity' => $identity, 'PolicyNames' => $policies, ]);

261

https://docs.aws.amazon.com/ses/latest/APIReference/API_GetIdentityPolicy.html



Répertorier les expéditeurs autorisésPour répertorier les stratégies d’autorisation d’envoi associées à une identité d’e-mail spécifique ou à uneidentité de domaine dans la région AWS actuelle, utilisez l’opération ListIdentityPolicies.

Importations



Exemple de code


$identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com";

try { $result = $SesClient->listIdentityPolicies([ 'Identity' => $identity, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Révoquer l’autorisation d’un expéditeur autoriséSupprimez l’autorisation d’envoi d’un autre compte AWS pour envoyer des e-mails avec une identitéd’e-mail ou une identité de domaine en supprimant la stratégie d’identité associée à l’aide de l’opérationDeleteIdentityPolicy.

Importations



262

https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentityPolicies.html

https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentityPolicy.html

AWS SDK pour PHP Manuel du développeurExemples Amazon SNS

Exemple de code


$identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com";$name = "policyName";

try { $result = $SesClient->deleteIdentityPolicy([ 'Identity' => $identity, 'PolicyName' => $name, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n";}

Exemples Amazon SNS avec le kit AWS SDK forPHP version 3

Amazon Simple Notification Service (Amazon SNS) est un service web qui coordonne et gère la mise àdisposition ou l’envoi de messages à des clients ou à des points de terminaison abonnés.

Dans Amazon SNS, il existe deux types de clients : les éditeurs (également appelés producteurs) et lesabonnés (consommateurs).

Les éditeurs communiquent de façon asynchrone avec les abonnés en produisant et en envoyant unmessage à une rubrique, qui est un point d'accès logique et un canal de communication. Les abonnés (parexemple, des serveurs web, des adresses e-mail, des files d’attente Amazon SQS, des fonctions AWSLambda) consomment ou reçoivent le message ou la notification via l’un des protocoles pris en charge(Amazon SQS, URL HTTP/HTTPS, e-mail, AWS SMS, Lambda) lorsqu’ils sont abonnés à la rubrique.


Rubriques• Gestion des rubriques dans Amazon SNS avec le kit AWS SDK for PHP version 3 (p. 264)

263



AWS SDK pour PHP Manuel du développeurGestion des rubriques

• Gestion des abonnements dans Amazon SNS avec le kit AWS SDK for PHP version 3 (p. 267)• Envoi de messages SMS dans Amazon SNS avec le kit AWS SDK for PHP version 3 (p. 273)

Gestion des rubriques dans Amazon SNS avec le kitAWS SDK for PHP version 3Pour envoyer des notifications à Amazon Simple Queue Service (Amazon SQS), URL HTTP/HTTPS,e-mail, AWS SMS ou AWS Lambda, vous devez d’abord créer une rubrique qui gère la livraison desmessages à tous les abonnés de cette rubrique.

En termes de conception du modèle d’observateur, une rubrique correspond à l’objet. Une fois qu’unerubrique est créée, vous ajoutez des abonnés qui reçoivent automatiquement une notification lorsqu’unmessage est publié dans cette rubrique.

Découvrez-en davantage sur l’abonnement aux rubriques à la section Gestion des abonnements dansAmazon SNS avec le kit AWS SDK pour PHP version 3 (p. 267).


• Créer une rubrique pour publier des notifications à l’aide de CreateTopic.• Retourner une liste des rubriques du demandeur à l'aide de ListTopics.• Supprimer une rubrique et tous ses abonnements à l’aide de DeleteTopic.• Retourner toutes les propriétés d’une rubrique à l’aide de GetTopicAttributes.• Autoriser un propriétaire de rubrique à définir un attribut de la rubrique sur une nouvelle valeur à l’aide de

SetTopicAttributes.

Pour plus d’informations sur l’utilisation de Amazon SNS, consultez la page Attributs des rubriquesAmazon SNS pour l’état de diffusion du message.



Création d'une rubriquePour créer une rubrique, utilisez l’opération CreateTopic.

Chaque nom de rubrique dans votre compte AWS doit être unique.

Importations


use Aws\Sns\SnsClient; use Aws\Exception\AwsException;

Exemple de code

264

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#createtopic

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listtopic

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#deletetopic

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#gettopicattributes

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#settopicattributes

https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html

https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html



https://docs.aws.amazon.com/sns/latest/api/API_API_CreateTopic.html


$SnSclient = new SnsClient([ 'profile' => 'default', 'region' => 'us-east-1', 'version' => '2010-03-31']);

$topicname = 'myTopic';

try { $result = $SnSclient->createTopic([ 'Name' => $topicname, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Répertorier vos rubriquesPour répertorier jusqu’à 100 rubriques existantes dans la région AWS actuelle, utilisez l’opérationListTopics.

Importations



Exemple de code


try { $result = $SnSclient->listTopics([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Suppression d'une rubriquePour supprimer une rubrique existante et tous ses abonnements, utilisez l’opération DeleteTopic.

Les messages qui n’ont pas encore été livrés aux abonnés seront également supprimés.

Importations



265

https://docs.aws.amazon.com/sns/latest/api/API_API_ListTopics.html

https://docs.aws.amazon.com/sns/latest/api/API_API_DeleteTopic.html


Exemple de code


$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->deleteTopic([ 'TopicArn' => $topic, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Obtenir les attributs de la rubriquePour récupérer les propriétés d’une rubrique existante, utilisez l’opération GetTopicAttributes.

Importations



Exemple de code


$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->getTopicAttributes([ 'TopicArn' => $topic, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Définir les attributs de la rubriquePour mettre à jour les propriétés d’une rubrique existante, utilisez l’opération SetTopicAttributes.

Vous ne pouvez définir que les attributs Policy, DisplayName et DeliveryPolicy.

Importations


266

https://docs.aws.amazon.com/sns/latest/api/API_API_GetTopicAttributes.html

https://docs.aws.amazon.com/sns/latest/api/API_API_SetTopicAttributes.html

AWS SDK pour PHP Manuel du développeurGestion des abonnements


Exemple de code

$SnSclient = new SnsClient([ 'profile' => 'default', 'region' => 'us-east-1', 'version' => '2010-03-31']);$attribute = 'Policy | DisplayName | DeliveryPolicy';$value = 'First Topic';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->setTopicAttributes([ 'AttributeName' => $attribute, 'AttributeValue' => $value, 'TopicArn' => $topic, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Gestion des abonnements dans Amazon SNS avec lekit AWS SDK for PHP version 3Utilisez les rubriques Amazon Simple Notification Service (Amazon SNS) pour envoyer des notificationsà Amazon Simple Queue Service (Amazon SQS), à des protocoles HTTP/HTTPS, à des adressesélectroniques AWS Server Migration Service (AWS SMS) ou à AWS Lambda.

Les abonnements sont attachés à une rubrique qui gère l’envoi de messages aux abonnés. Découvrez-endavantage sur la création de rubriques à la section Gestion des rubriques dans Amazon SNS avec le kitAWS SDK pour PHP version 3 (p. 264).


• S’abonner à une rubrique existante à l’aide de Subscribe.• Vérifier un abonnement à l’aide de ConfirmSubscription.• Répertorier les abonnements existants à l’aide de ListSubscriptionsByTopic.• Supprimer un abonnement à l’aide de Unsubscribe.• Envoyer un message à tous les abonnés d’une rubrique à l’aide de Publish.

Pour plus d’informations sur l’utilisation de Amazon SNS, consultez la section Utilisation d’Amazon SNSpour la messagerie de système à système.



267

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#subscribe

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#confirmsubscription

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listsubscriptionsbytopic

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#unsubscribe

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#publish

https://docs.aws.amazon.com/sns/latest/dg/sns-system-to-system-messaging.html

https://docs.aws.amazon.com/sns/latest/dg/sns-system-to-system-messaging.html





Abonner une adresse e-mail à une rubriquePour lancer un abonnement à une adresse e-mail, utilisez l’opération Subscribe.

Vous pouvez utiliser la méthode Subscribe pour abonner plusieurs points de terminaison à une rubriqueAmazon SNS, en fonction des valeurs utilisées pour les paramètres passés. Cette action est présentéedans d’autres exemples de cette rubrique.

Dans cet exemple, le point de terminaison est une adresse e-mail. Un jeton de confirmation est envoyéà cette adresse e-mail. Vérifiez l’abonnement avec ce jeton de confirmation dans un délai de trois jours àcompter de la réception.

Importations



Exemple de code


$protocol = 'email';$endpoint = '[email protected]';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->subscribe([ 'Protocol' => $protocol, 'Endpoint' => $endpoint, 'ReturnSubscriptionArn' => true, 'TopicArn' => $topic, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Abonner un point de terminaison d’application à une rubriquePour lancer un abonnement à une application Web, utilisez l’opération Subscribe.


Dans cet exemple, le point de terminaison est une URL. Un jeton de confirmation est envoyé à cetteadresse Web. Vérifiez l’abonnement avec ce jeton de confirmation dans un délai de trois jours à compterde la réception.

Importations

268

https://docs.aws.amazon.com/sns/latest/api/API_API_Subscribe.html





Exemple de code


$protocol = 'https';$endpoint = 'https://';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';


Abonner une fonction Lambda à une rubriquePour lancer un abonnement à une fonction Lambda, utilisez l’opération Subscribe.


Dans cet exemple, le point de terminaison est une fonction Lambda. Un jeton de confirmation est envoyé àcette fonction Lambda. Vérifiez l’abonnement avec ce jeton de confirmation dans un délai de trois jours àcompter de la réception.

Importations



Exemple de code


$protocol = 'lambda';$endpoint = 'arn:aws:lambda:us-east-1:123456789023:function:messageStore';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

269




Abonner un SMS textuel à une rubriquePour envoyer des messages SMS à plusieurs numéros de téléphone en même temps, abonnez chaquenuméro à une rubrique.

Pour lancer un abonnement à un numéro de téléphone, utilisez l’opération Subscribe.


Dans cet exemple, le point de terminaison est un numéro de téléphone au format E.164, une normeinternationale de télécommunications.

Un jeton de confirmation est envoyé à ce numéro de téléphone. Vérifiez l’abonnement avec ce jeton deconfirmation dans un délai de trois jours à compter de la réception.

Pour obtenir un autre moyen d’envoyer des messages SMS Amazon SNS, consultez la section Envoi demessages SMS dans Amazon SNS avec le kit AWS SDK pour PHP version 3 (p. 273).

Importations



Exemple de code


$protocol = 'sms';$endpoint = '+1XXX5550100';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->subscribe([ 'Protocol' => $protocol, 'Endpoint' => $endpoint, 'ReturnSubscriptionArn' => true, 'TopicArn' => $topic, ]); var_dump($result);

270



} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Confirmer l’abonnement à une rubriquePour créer un abonnement, le propriétaire du point de terminaison doit confirmer l’intention de recevoir desmessages envoyés par la rubrique à l’aide d’un jeton transmis lorsqu’un abonnement est établi initialement,comme indiqué précédemment. Les jetons de confirmation sont valides pendant trois jours. Au bout de troisjours, vous pouvez renvoyer un jeton en créant un nouvel abonnement.

Pour confirmer un abonnement, utilisez l’opération ConfirmSubscription.

Importations



Exemple de code


$subscription_token = 'arn:aws:sns:us-east-1:111122223333:MyTopic:123456-abcd-12ab-1234-12ba3dc1234a';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->subscribe([ 'Token' => $subscription_token, 'TopicArn' => $topic, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Répertorier les abonnements à une rubriquePour répertorier jusqu’à 100 abonnements existants dans une région AWS donnée, utilisez l’opérationListSubscriptions.

Importations



Exemple de code

$SnSclient = new SnsClient([

271

https://docs.aws.amazon.com/sns/latest/api/API_API_ConfirmSubscription.html

https://docs.aws.amazon.com/sns/latest/api/API_API_ListSubscriptions.html


'profile' => 'default', 'region' => 'us-east-1', 'version' => '2010-03-31']);

try { $result = $SnSclient->listSubscriptions([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Annulation de l'abonnement à une rubriquePour supprimer un point de terminaison abonné à une rubrique, utilisez l’opération Unsubscribe.

Si une authentification est nécessaire pour la suppression de l'abonnement, seul le propriétaire del'abonnement ou de la rubrique peut se désabonner, et une signature AWS est nécessaire. Si l'appelde désabonnement ne nécessite pas l'authentification et si le demandeur n'est pas le propriétaire del'abonnement, un message d'annulation final est remis au point de terminaison.

Importations



Exemple de code


$subscription = 'arn:aws:sns:us-east-1:111122223333:MySubscription';

try { $result = $SnSclient->unsubscribe([ 'SubscriptionArn' => $subscription, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Publier un message dans une rubrique Amazon SNSPour envoyer un message à chaque point de terminaison abonné à une rubrique Amazon SNS, utilisezl'opération Publish.

Créez un objet qui contient les paramètres de publication d’un message, y compris le texte du message etl’Amazon Resource Name (ARN) de la rubrique Amazon SNS.

Importations

272

https://docs.aws.amazon.com/sns/latest/api/API_API_Unsubscribe.html

https://docs.aws.amazon.com/sns/latest/api/API_API_Publish.html

AWS SDK pour PHP Manuel du développeurEnvoi de messages SMS Amazon



Exemple de code


$message = 'This message is sent from a Amazon SNS code sample.';$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try { $result = $SnSclient->publish([ 'Message' => $message, 'TopicArn' => $topic, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Envoi de messages SMS dans Amazon SNS avec lekit AWS SDK for PHP version 3Vous pouvez utiliser Amazon Simple Notification Service (Amazon SNS) pour envoyer des messages texteou des messages SMS, à des appareils compatibles SMS. Vous pouvez envoyer un message directementà un numéro de téléphone, ou vous pouvez envoyer un message à plusieurs numéros de téléphonesimultanément en abonnant ces numéros de téléphone à une rubrique et en envoyant votre message à larubrique.

Utilisez Amazon SNS pour définir des préférences pour les SMS, par exemple l'optimisation de vosdiffusions (coût ou fiabilité), votre limite de dépenses mensuelles, la consignation des diffusions demessages et l'abonnement à des rapports d'utilisation quotidiens des SMS. Ces préférences sontrécupérées et définies comme attributs SMS pour Amazon SNS.

Lorsque vous envoyez un SMS, spécifiez le numéro de téléphone au format E.164. E.164 est une normepour la structure des numéros de téléphone. Elle est utilisée pour les télécommunications internationales.Les numéros qui respectent ce format peuvent comporter 15 chiffres au maximum et commencent parle caractère plus (+) et le code pays. Par exemple, un numéro de téléphone américain au format E.164apparaît sous la forme +1001XXX5550100.


• Récupérer les paramètres par défaut pour l’envoi de messages SMS à partir de votre compte à l’aide deGetSMSAttributes.

• Mettre à jour les paramètres par défaut pour l’envoi de messages SMS à partir de votre compte à l’aidede SetSMSAttributes.

• Découvrir si un numéro de téléphone propriétaire a choisi de recevoir des messages SMS provenant devotre compte à l’aide de CheckIfPhoneNumberIsOptedOut.

• Répertorier les numéros de téléphone dont le propriétaire a choisi de ne plus recevoir de messages SMSprovenant de votre compte à l'aide de ListPhoneNumberOptedOut.

273

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#getsmsattributes

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#setsmsattributes

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#checkifphonenumberisoptedout

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listphonenumbersoptedout


• Envoyer un message texte (SMS) directement à un numéro de téléphone à l’aide de Publish.

Pour plus d’informations sur l’utilisation de Amazon SNS, consultez la section Utilisation d’Amazon SNSpour les notifications de l’utilisateur avec un numéro de téléphone mobile en tant qu’abonné (envoi deSMS).



Obtenir les attributs des SMSPour récupérer les paramètres par défaut des messages SMS, utilisez l’opération GetSMSAttributes.

Cet exemple permet d’obtenir l’attribut DefaultSMSType. Cet attribut contrôle si les messages SMS sontenvoyés en tant que Promotional, ce qui optimise la transmission des messages au plus bas coût ou entant que Transactional, ce qui optimise la transmission des messages à une fiabilité optimale.

Importations



Exemple de code


try { $result = $SnSclient->getSMSAttributes([ 'attributes' => ['DefaultSMSType'], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Définir les attributs des SMSPour mettre à jour les paramètres par défaut des messages SMS, utilisez l’opération SetSMSAttributes.

Cet exemple définit l’attribut DefaultSMSType sur Transactional, ce qui optimise la transmission demessage à une fiabilité optimale.

Importations

274

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#publish

https://docs.aws.amazon.com/sns/latest/dg/sns-mobile-phone-number-as-subscriber.html





https://docs.aws.amazon.com/sns/latest/api/API_API_GetSMSAttributes.html

https://docs.aws.amazon.com/sns/latest/api/API_API_SetSMSAttributes.html




Exemple de code


try { $result = $SnSclient->SetSMSAttributes([ 'attributes' => [ 'DefaultSMSType' => 'Transactional', ], ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Vérifier si un numéro de téléphone est désinscritPour déterminer si le propriétaire d’un numéro de téléphone s’est désinscrit de la réception des messagesSMS provenant de votre compte, utilisez l’opération CheckIfPhoneNumberIsOptedOut.

Dans cet exemple, le numéro de téléphone est au format E.164, une norme internationale detélécommunications.

Importations



Exemple de code


$phone = '+1XXX5550100';

try { $result = $SnSclient->checkIfPhoneNumberIsOptedOut([ 'phoneNumber' => $phone, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());

275

https://docs.aws.amazon.com/sns/latest/api/API_API_CheckIfPhoneNumberIsOptedOut.html


}

Répertorier les numéros de téléphone désinscritsPour récupérer une liste des numéros de téléphone dont le propriétaire a choisi de ne pas recevoir lesmessages SMS provenant de votre compte, utilisez l’opération ListPhoneNumbersOptedOut.

Importations



Exemple de code


try { $result = $SnSclient->listPhoneNumbersOptedOut([ ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Publier un message texte (message SMS)Pour diffuser un message texte (SMS) directement à un numéro de téléphone, utilisez l’opération Publish.

Dans cet exemple, le numéro de téléphone est au format E.164, une norme internationale detélécommunications.

Les messages SMS peuvent contenir jusqu’à 140 octets. La limite de taille pour une action de publicationde SMS est de 1 600 octets.

Pour plus d’informations sur l’envoi de messages SMS, consultez la section Envoi d’un message SMS.

Importations



Exemple de code


276

https://docs.aws.amazon.com/sns/latest/api/API_API_ListPhoneNumbersOptedOut.html

https://docs.aws.amazon.com/sns/latest/api/API_API_Publish.html

https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html

AWS SDK pour PHP Manuel du développeurExemples Amazon SQS

$message = 'This message is sent from a Amazon SNS code sample.';$phone = '+1XXX5550100';

try { $result = $SnSclient->publish([ 'Message' => $message, 'PhoneNumber' => $phone, ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Exemples Amazon SQS avec le kit AWS SDK forPHP version 3

Amazon Simple Queue Service (SQS) est un service de file d’attente de messagerie rapide, fiable, évolutifet totalement géré. Amazon SQS vous permet de découpler les composants d’une application cloud.Amazon SQS comprend des files d’attente standard avec un débit élevé et un traitement à au moins unereprise, ainsi que des files d’attente FIFO (premier entré, premier sorti) qui assurent la livraison FIFO et untraitement à exactement une reprise.


Rubriques• Activation de l’attente active de longue durée dans Amazon SQS avec le kit AWS SDK for PHP

version 3 (p. 277)• Gestion du délai de visibilité dans Amazon SQS avec le kit AWS SDK for PHP version 3 (p. 280)• Envoi et réception de messages dans Amazon SQS avec le kit AWS SDK for PHP version 3 (p. 281)• Utilisation des files d’attente de lettres mortes dans Amazon SQS avec le kit AWS SDK for PHP

version 3 (p. 283)• Utilisation des files d’attente dans Amazon SQS avec le kit AWS SDK pour PHP version 3 (p. 284)

Activation de l’attente active de longue durée dansAmazon SQS avec le kit AWS SDK for PHP version 3L'attente active de longue durée réduit le nombre de réponses vides en permettant à Amazon SQSd'attendre pendant un temps spécifié qu'un message soit disponible dans la file d'attente avant d'envoyer

277



AWS SDK pour PHP Manuel du développeurActivation de l’attente active de longue durée

une réponse. L'attente active de longue durée élimine également les fausses réponses vides eninterrogeant tous les serveurs, à la place d'un simple échantillon. Pour activer l'attente active de longuedurée, spécifiez un temps d'attente différent de zéro pour les messages reçus. Pour en savoir plus,consultez la section Attente active de longue durée SQS.


• Définir des attributs sur une file d’attente Amazon SQS pour activer l’attente active de longue durée àl’aide de SetQueueAttributes.

• Récupérer un ou plusieurs messages via l’attente active de longue durée à l’aide de ReceiveMessage.• Créer une nouvelle file d’attente active de longue durée à l’aide de CreateQueue.



Définir des attributs sur une file d'attente pour activer l'attenteactive de longue duréeImportations


use Aws\Sqs\SqsClient; use Aws\Exception\AwsException;

Exemple de code

$queueUrl = "QUEUE_URL";

$client = new SqsClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2012-11-05']);

try { $result = $client->setQueueAttributes(array( 'Attributes' => [ 'ReceiveMessageWaitTimeSeconds' => 20 ], 'QueueUrl' => $queueUrl, // REQUIRED )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

278

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#setqueueattributes

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#receivemessage

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#createqueue



AWS SDK pour PHP Manuel du développeurActivation de l’attente active de longue durée

Récupérer des messages via l'attente active de longueur duréeImportations



Exemple de code



try { $result = $client->receiveMessage(array( 'AttributeNames' => ['SentTimestamp'], 'MaxNumberOfMessages' => 1, 'MessageAttributeNames' => ['All'], 'QueueUrl' => $queueUrl, // REQUIRED 'WaitTimeSeconds' => 20, )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Créer une file d'attente via l'attente active de longue duréeImportations



Exemple de code

$queueName = "QUEUE_NAME";


try { $result = $client->createQueue(array( 'QueueName' => $queueName, 'Attributes' => array(

279

AWS SDK pour PHP Manuel du développeurGestion du délai de visibilité

'ReceiveMessageWaitTimeSeconds' => 20 ), )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Gestion du délai de visibilité dans Amazon SQS avecle kit AWS SDK for PHP version 3Un délai de visibilité est une période donnée au cours de laquelle Amazon SQS empêche les autrescomposants utilisateurs de recevoir et de traiter un message. Pour en savoir plus, consultez la sectionDélai de visibilité.


• Modifier le délai de visibilité de messages spécifiés dans une file d’attente avec de nouvelles valeurs àl’aide de ChangeMessageVisibilityBatch.



Modifier le délai de visibilité de plusieurs messagesImportations



Exemple de code

$queueUrl = "QUEUE_URL"; $client = new SqsClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2012-11-05']);

try { $result = $client->receiveMessage(array( 'AttributeNames' => ['SentTimestamp'],

280

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#changemessagevisibilitybatch



AWS SDK pour PHP Manuel du développeurEnvoi et réception de messages

'MaxNumberOfMessages' => 10, 'MessageAttributeNames' => ['All'], 'QueueUrl' => $queueUrl, // REQUIRED )); $messages = $result->get('Messages'); if ($messages != null) { $entries = array(); for ($i = 0; $i < count($messages); $i++) { array_push($entries, [ 'Id' => 'unique_is_msg' . $i, // REQUIRED 'ReceiptHandle' => $messages[$i]['ReceiptHandle'], // REQUIRED 'VisibilityTimeout' => 3600 ]); } $result = $client->changeMessageVisibilityBatch([ 'Entries' => $entries, 'QueueUrl' => $queueUrl ]);

var_dump($result); } else { echo "No messages in queue \n"; }} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Envoi et réception de messages dans Amazon SQSavec le kit AWS SDK for PHP version 3Pour en savoir plus sur les messages Amazon SQS, consultez les sections Envoi d’un message à unefile d’attente SQS et Réception et suppression d’un message d’une file d’attente SQS du Amazon SQSDeveloper Guide.


• Envoyer un message à une file d’attente spécifiée à l’aide de SendMessage.• Récupérer un ou plusieurs messages (jusqu’à 10) d’une file d’attente spécifiée à l’aide de

ReceiveMessage.• Supprimer un message d’une file d’attente à l’aide de DeleteMessage.



Envoi d'un messageImportations

281

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-send-message.html

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-send-message.html

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-receive-delete-message.html.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#sendmessage

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#receivemessage

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#deletemessage



AWS SDK pour PHP Manuel du développeurEnvoi et réception de messages



Exemple de code


$params = [ 'DelaySeconds' => 10, 'MessageAttributes' => [ "Title" => [ 'DataType' => "String", 'StringValue' => "The Hitchhiker's Guide to the Galaxy" ], "Author" => [ 'DataType' => "String", 'StringValue' => "Douglas Adams." ], "WeeksOn" => [ 'DataType' => "Number", 'StringValue' => "6" ] ], 'MessageBody' => "Information about current NY Times fiction bestseller for week of 12/11/2016.", 'QueueUrl' => 'QUEUE_URL'];

try { $result = $client->sendMessage($params); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Recevoir et supprimer des messagesImportations



Exemple de code


$client = new SqsClient([ 'profile' => 'default', 'region' => 'us-west-2',

282

AWS SDK pour PHP Manuel du développeurUtilisation des files d’attente de lettres mortes

'version' => '2012-11-05']);

try { $result = $client->receiveMessage(array( 'AttributeNames' => ['SentTimestamp'], 'MaxNumberOfMessages' => 1, 'MessageAttributeNames' => ['All'], 'QueueUrl' => $queueUrl, // REQUIRED 'WaitTimeSeconds' => 0, )); if (!empty($result->get('Messages'))) { var_dump($result->get('Messages')[0]); $result = $client->deleteMessage([ 'QueueUrl' => $queueUrl, // REQUIRED 'ReceiptHandle' => $result->get('Messages')[0]['ReceiptHandle'] // REQUIRED ]); } else { echo "No messages in queue. \n"; }} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation des files d’attente de lettres mortes dansAmazon SQS avec le kit AWS SDK for PHP version 3Une file d'attente de lettres mortes peut être ciblée par d'autres files d'attente (source) pour les messagesne pouvant pas être traités avec succès. Vous pouvez mettre de côté et isoler ces messages dans la filed’attente de lettres mortes pour déterminer pourquoi leur traitement a échoué. Vous devez configurerindividuellement chaque file d’attente source qui envoie des messages à une file d’attente de lettresmortes. Plusieurs files d'attente peuvent cibler une seule file d'attente de lettres mortes.

Pour en savoir plus, consultez la section Utilisation des files d’attente de lettres mortes SQS.


• Activer une file d’attente de lettres mortes avec SetQueueAttributes.



Activer une file d’attente de lettres mortesImportations


283

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#setqueueattributes



AWS SDK pour PHP Manuel du développeurUtilisation de files d’attente


Exemple de code



try { $result = $client->setQueueAttributes([ 'Attributes' => [ 'RedrivePolicy' => "{\"deadLetterTargetArn\":\"DEAD_LETTER_QUEUE_ARN\",\"maxReceiveCount\":\"10\"}" ], 'QueueUrl' => $queueUrl // REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Utilisation des files d’attente dans Amazon SQS avecle kit AWS SDK pour PHP version 3Pour en savoir plus sur les files d’attente Amazon SQS, consultez la section Fonctionnement des filesd’attente SQS.


• Renvoyer une liste de vos files d’attente à l’aide de ListQueues.• Créer une nouvelle file d’attente à l’aide de CreateQueue.• Renvoyer l’URL d’une file d’attente existante à l’aide de GetQueueUrl.• Supprimer une file d’attente spécifiée à l’aide de DeleteQueue.



Renvoi d'une liste de files d'attenteImportations

284

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-how-it-works.html

https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-how-it-works.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#listqueues

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#createqueue

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#getqueueurl

https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#deletequeue






Exemple de code


try { $result = $client->listQueues(); foreach ($result->get('QueueUrls') as $queueUrl) { echo "$queueUrl\n"; }} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Création d'une file d'attenteImportations



Exemple de code

$queueName = "SQS_QUEUE_NAME"; $client = new SqsClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2012-11-05']);

try { $result = $client->createQueue(array( 'QueueName' => $queueName, 'Attributes' => array( 'DelaySeconds' => 5, 'MaximumMessageSize' => 4096, // 4 KB ), )); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

285


Renvoi de l'URL d'une file d'attenteImportations



Exemple de code

$queueName = "SQS_QUEUE_NAME"; $client = new SqsClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2012-11-05']);

try { $result = $client->getQueueUrl([ 'QueueName' => $queueName // REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());}

Suppression d'une file d'attenteImportations



Exemple de code

$queueUrl = "SQS_QUEUE_URL"; $client = new SqsClient([ 'profile' => 'default', 'region' => 'us-west-2', 'version' => '2012-11-05']);

try { $result = $client->deleteQueue([ 'QueueUrl' => $queueUrl // REQUIRED ]); var_dump($result);} catch (AwsException $e) { // output error message if fails error_log($e->getMessage());

286


}

287

AWS SDK pour PHP Manuel du développeurProtection des données

Sécurité pour this AWS Product orService

Chez Amazon Web Services (AWS), la sécurité dans le cloud est notre priorité numéro 1. En tant que clientAWS, vous bénéficiez d'un centre de données et d'une architecture réseau conçus pour répondre auxexigences des organisations les plus pointilleuses en termes de sécurité. La sécurité est une responsabilitépartagée entre AWS et vous-même. Le modèle de responsabilité partagée décrit ceci comme la sécurité ducloud et la sécurité dans le cloud.

Sécurité du cloud– AWS est responsable de la protection de l'infrastructure qui exécute tous les servicesproposés dans le cloud AWS et doit vous fournir des services que vous pouvez utiliser en toute sécurité.Chez AWS, notre responsabilité en matière de sécurité est la priorité la plus élevée, et l'efficacité de notresécurité est régulièrement testée et vérifiée par des auditeurs tiers dans le cadre des programmes deconformité AWS.

Sécurité dans le cloud– Votre responsabilité est déterminée par le service AWS que vous utilisez et pard'autres facteurs, notamment la sensibilité de vos données, les exigences de votre organisation, ainsi queles lois et réglementations applicables.

Rubriques• Protection des données dans this AWS Product or Service (p. 288)• Identity and Access Management pour this AWS Product or Service (p. 289)• Validation de la conformité pour this AWS Product or Service (p. 289)• Résilience pour this AWS Product or Service (p. 290)• Sécurité de l'infrastructure pour this AWS Product or Service (p. 290)

Protection des données dans this AWS Product orService

This AWS product or service se conforme au modèle de responsabilité partagée, qui comprend desdirectives et des régulations pour la protection des données. Amazon Web Services (AWS) est responsablede la protection de l'infrastructure globale qui exécute tous les services AWS. AWS conserve le contrôledes données hébergées sur cette infrastructure, y compris les contrôles de configuration de sécurité pourtraiter le contenu et les données personnelles des clients. Les clients AWS et les partenaires APN, qu'ilsagissent en tant que contrôleurs ou responsables du traitement des données, sont responsables de toutesles données personnelles qu'ils mettent sur le cloud AWS.

Pour des raisons de protection des données, nous vous recommandons de protéger vos identifiantsde compte AWS et de configurer des comptes utilisateurs individuels avec AWS Identity and AccessManagement (IAM), afin que chaque utilisateur reçoive uniquement les permissions nécessaires pouraccomplir ses tâches. Nous vous recommandons également de sécuriser vos données comme indiqué ci-dessous :

• Utilisez l'authentification multi-facteurs (MFA) avec chaque compte.• Utilisez TLS v1.2 ou version ultérieure pour communiquer avec les ressources AWS. Toutes les versions

de SSL et de TLS antérieures à la version 1.2 présentent des vulnérabilités connues qui peuventcompromettre la sécurité. Veuillez consulter les options de configuration http_handler (p. 37) pour de plusamples informations sur la spécification de la version TLS minimale.

• Configurez l'API et la consignation des activités utilisateur avec AWS CloudTrail.

288

https://aws.amazon.com/compliance/shared-responsibility-model/

https://aws.amazon.com/compliance/programs/


https://aws.amazon.com/compliance/shared-responsibility-model

AWS SDK pour PHP Manuel du développeurGestion des identités et des accès

• Utilisez des solutions de chiffrement AWS, ainsi que tous les contrôles de sécurité par défaut au sein desservices AWS.

• Utilisez des services de sécurité gérés comme Amazon Macie, qui contribue à la découverte et à lasécurisation des données personnelles stockées dans Amazon S3.

Nous vous recommandons vivement de ne jamais placer d'informations identifiables sensibles, telles quedes numéros de compte de vos clients, dans des champs de formulaire comme Nom. Cela inclut lorsquevous utilisez this AWS product or service ou d'autres services AWS à l'aide de la console, de l'API, del'interface de ligne de commande (AWS CLI) ou des kits SDK AWS. Toutes les données que vous entrezdans this AWS product or service ou d'autres services peuvent être récupérées pour être insérées dansdes journaux de diagnostic. Lorsque vous fournissez une URL à un serveur externe, n'incluez pas lesinformations d'identification non chiffrées dans l'URL pour valider votre demande adressée au serveur.

Pour de plus amples informations sur la protection des données, veuillez consulter le billet de blog Modèlede responsabilité partagée d’AWS et RGPD sur le Blog sur la sécurité d’AWS.

Identity and Access Management pour this AWSProduct or Service

AWS Identity and Access Management (IAM) est un service Amazon Web Services (AWS) qui permetà un administrateur de contrôler en toute sécurité l'accès aux ressources AWS. Les administrateursIAM contrôlent les personnes pouvant être authentifiées (connectées) et autorisées (disposant desautorisations) à utiliser les ressources dans des services AWS. IAM est un service AWS que vous pouvezutiliser sans frais supplémentaires.

Pour utiliser this AWS product or service pour accéder à AWS, vous avez besoin d'un compte AWSet d'informations d'identification AWS. Pour accroître la sécurité de votre compte AWS, nous vousrecommandons de recourir à un utilisateur IAM pour fournir les informations d'identification d'accès plutôtque d'utiliser les informations d'identification de votre compte AWS.

Pour plus d'informations sur l'utilisation d'IAM, veuillez consulter IAM.

Pour obtenir une présentation des utilisateurs IAM et des raisons pour lesquelles ils sont importants dans lecadre la sécurité de votre compte, veuillez consulter Informations d'identification de sécurité AWS dans lesRéférences générales Amazon Web Services.

This AWS product or service suit le modèle de responsabilité partagée par le biais des services AmazonWeb Services (AWS) spécifiques qu'il prend en charge. Pour plus d'informations sur la sécurité desservices AWS, veuillez consulter la page de documentation sur la sécurité des services AWS et lesservices AWS qui font partie des efforts de conformité AWS par programme de conformité.

Validation de la conformité pour this AWS Productor Service


La sécurité et la conformité des services Amazon Web Services (AWS) sont évaluées par des auditeurstiers dans le cadre de plusieurs programmes de conformité AWS. Il s'agit notamment de normes SOC, PCI,FedRAMP, HIPAA et autres. AWS fournit une liste mise à jour régulièrement des services AWS concernés

289

http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/

http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/

https://aws.amazon.com/iam/

https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html

https://docs.aws.amazon.com/general/latest/gr/


https://aws.amazon.com/security/?id=docs_gateway#aws-security

https://aws.amazon.com/compliance/services-in-scope/




AWS SDK pour PHP Manuel du développeurRésilience

par des programmes de conformité spécifiques sur la page Services AWS concernés par le programme deconformité.

Les rapports d'audit tiers sont disponibles pour téléchargement à l'aide de AWS Artifact. Pour de plusamples informations, veuillez consulter Téléchargement des rapports dans AWS Artifact.

Pour de plus amples informations sur les programmes de conformité AWS, veuillez consulter Programmesde conformité AWS.

Votre responsabilité de conformité lorsque vous utilisez this AWS product or service pour accéder àun service AWS est déterminée par la sensibilité de vos données, les objectifs de conformité de votreorganisation, ainsi que par la législation et la réglementation applicables. Si votre utilisation d'un serviceAWS doit être conforme aux normes HIPAA, PCI, ou FedRAMP, AWS fournit des ressources pour vousaider :

• Guides de démarrage rapide de la sécurité et de la conformité– Guides de déploiement qui proposentdes considérations architecturales et fournissent des procédures pour déployer des environnements deréférence centrés sur la sécurité et la conformité sur AWS.

• Livre blanc sur l'architecture pour la sécurité et la conformité HIPAA– Livre blanc qui décrit comment lesentreprises peuvent utiliser AWS pour créer des applications conformes à la loi HIPAA.

• Ressources de conformité AWS – Ensemble de manuels et de guides susceptible de s'appliquer à votresecteur et à votre emplacement.

• AWS Config – Service qui permet d'évaluer comment les configurations de vos ressources se conformentaux pratiques internes, aux normes et aux directives industrielles.

• AWS Security Hub– Vue complète de l'état de votre sécurité au sein d'AWS, qui vous permet de vérifiervotre conformité aux normes du secteur et aux bonnes pratiques de sécurité.

Résilience pour this AWS Product or ServiceL'infrastructure mondiale d'Amazon Web Services (AWS) repose sur les régions et les zones dedisponibilité AWS.

Les régions AWS fournissent plusieurs zones de disponibilité physiquement séparées et isolées, reliées parun réseau à latence faible, à débit élevé et à forte redondance.

Avec les zones de disponibilité, vous pouvez concevoir et exploiter des applications et des bases dedonnées qui basculent automatiquement d'une zone de disponibilité à l'autre sans interruption. Les zonesde disponibilité sont plus hautement disponibles, tolérantes aux pannes et évolutives que les infrastructurestraditionnelles à un ou plusieurs centres de données.

Pour de plus amples informations sur les régions et les zones de disponibilité AWS, veuillezconsulterInfrastructure mondiale AWS.


Sécurité de l'infrastructure pour this AWS Product orService

This AWS product or service suit le modèle de responsabilité partagée par le biais des services AmazonWeb Services (AWS) spécifiques qu'il prend en charge. Pour plus d'informations sur la sécurité des

290



https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html



https://aws.amazon.com/quickstart/?quickstart-all.sort-by=item.additionalFields.updateDate&quickstart-all.sort-order=desc&awsf.quickstart-homepage-filter=categories%23security-identity-compliance

https://d0.awsstatic.com/whitepapers/compliance/AWS_HIPAA_Compliance_Whitepaper.pdf

https://aws.amazon.com/compliance/resources/

https://aws.amazon.com/config/

https://aws.amazon.com/security-hub

https://aws.amazon.com/about-aws/global-infrastructure/





AWS SDK pour PHP Manuel du développeurSécurité de l'infrastructure

services AWS, veuillez consulter la page de documentation sur la sécurité des services AWS et lesservices AWS qui font partie des efforts de conformité AWS par programme de conformité.

Pour de plus amples informations sur les processus de sécurité AWS, veuillez consulte le livre blanc AWS :Présentation des processus de sécurité .

291



https://d0.awsstatic.com/whitepapers/Security/AWS_Security_Whitepaper.pdf

https://d0.awsstatic.com/whitepapers/Security/AWS_Security_Whitepaper.pdf

AWS SDK pour PHP Manuel du développeurQuelles méthodes sont disponibles sur un client ?

FAQ du kit AWS SDK for PHPversion 3

Quelles méthodes sont disponibles sur un client ?Le kit AWS SDK for PHP utilise les descriptions de service et les méthodes _call() magiques dynamiquespour exécuter des opérations d’API. Vous trouverez la liste complète des méthodes disponibles pour unclient de service Web dans la documentation d’API du client.

Que dois-je faire en cas d'erreur de certificat cURLSSL ?

Ce problème peut survenir lors de l'utilisation d'un bundle d'autorité de certification (CA) obsolète aveccURL et SSL. Vous pouvez contourner ce problème en mettant à jour le bundle d’autorité de certification(CA) sur votre serveur ou en téléchargeant directement un bundle plus à jour depuis le site Web cURL.

Par défaut, le kit AWS SDK for PHP utilisera le bundle d'autorité de certification (CA) configuré lors de lacompilation de PHP. Vous pouvez modifier le bundle d'autorité de certification (CA) par défaut utilisé parPHP en modifiant le paramètre de configuration .ini PHP openssl.cafile à définir par le chemin d'accèsd'un fichier d'autorité de certification (CA) sur disque.

Quelles versions d'API sont disponibles pour unclient ?

Une option version est requise lors de la création d'un client. Vous trouverez la liste des versions d'APIdisponibles sur la page de documentation de l'API de chaque client ::aws-php-class:<index.html>. Si vousne parvenez pas à charger une version d'API spécifique, il se peut que vous deviez mettre à jour votrecopie du kit AWS SDK for PHP.

Vous pouvez spécifier la chaîne latest dans la valeur de configuration « version » pour utiliser la versiond'API disponible la plus récente du fournisseur d'API de votre client (le fournisseur d'API par défautrecherchera les modèles d'API disponibles dans le répertoire src/data du kit SDK).

Warning

Nous vous déconseillons de spécifier latest dans une application en production. En effet,l'intégration d'une nouvelle version mineure du kit SDK comprenant une mise à jour d'API peutentraîner l'échec de votre application en production.

292

http://www.php.net/manual/en/language.oop5.overloading.php#object.call

https://docs.aws.amazon.com/aws-sdk-php/v3/api//index.html

http://curl.haxx.se/docs/caextract.html

AWS SDK pour PHP Manuel du développeurQuelles versions de région sont disponibles pour un client ?

Quelles versions de région sont disponibles pour unclient ?

L'option region est requise lors de la création d'un client et doit être spécifiée à l'aide d'une valeur dechaîne. Pour connaître la liste des régions et points de terminaison AWS disponibles, consultez la sectionRégions et points de terminaison AWS du Amazon Web Services General Reference.

// Set the Region to the EU (Frankfurt) Region.$s3 = new Aws\S3\S3Client([ 'region' => 'eu-central-1', 'version' => '2006-03-01']);

Pourquoi ne puis-je pas charger ou télécharger desfichiers de plus de 2 Go ?

Le type entier de PHP étant signé et de nombreuses plateformes utilisant les entiers 32 bits, le kit AWSSDK for PHP ne gère pas correctement les fichiers de plus de 2 Go sur une pile 32 bits (où « pile » inclutl'UC, le système d'exploitation, le serveur Web et le binaire PHP). Il s’agit d’un problème connu de PHP.Dans le cas de Microsoft Windows, seules les versions de PHP 7 prennent en charge les entiers 64 bits.

La solution recommandée consiste à utiliser une pile Linux 64 bits, telle que l’AMI Linux Amazon 64 bits,dotée de la dernière version de PHP.

Pour plus d’informations, consultez la section Taille de fichier PHP : valeurs renvoyées.

Comment savoir quelles données sont envoyéessur le réseau ?

Vous pouvez obtenir des informations de débogage, y compris les données envoyées sur le réseau, àl'aide de l'option debug d'un constructeur client. Lorsque cette option est définie sur true, l'ensemble desmutations de la commande exécutée, de la requête envoyée, de la réponse reçue et du résultat traité sontémises vers STDOUT. Cela inclut les données envoyées et reçues sur le réseau.

$s3Client = new Aws\S3\S3Client([ 'region' => 'us-standard', 'version' => '2006-03-01', 'debug' => true]);

Comment puis-je définir des en-têtes arbitraires surune requête ?

Vous pouvez ajouter des en-têtes arbitraires à une opération de service en ajoutant unintergiciel personnalisé à la Aws\HandlerList d'une Aws\CommandInterface ou d'une Aws

293


http://www.google.com/search?q=php+2gb+32-bit

https://aws.amazon.com/amazon-linux-ami/

http://docs.php.net/manual/en/function.filesize.php#refsect1-function.filesize-returnvalues

AWS SDK pour PHP Manuel du développeurComment puis-je signer une requête arbitraire ?

\ClientInterface. L’exemple suivant montre comment ajouter un en-tête X-Foo-Baz à une opérationAmazon S3PutObject spécifique à l’aide de la méthode d’assistance Aws\Middleware::mapRequest.

Pour plus d’informations, consultez la section mapRequest (p. 74).

Comment puis-je signer une requête arbitraire ?Vous pouvez signer une requête arbitraire :aws-php-class: PSR-7</class-Psr.Http.Message.RequestInterface.html> avec la classe :aws-php-class: SignatureV4 </class-Aws.Signature.SignatureV4.html> du kit SDK.

Consultez la section Signature de requêtes de domaine Amazon CloudSearch personnalisées avec le kitAWS SDK pour PHP version 3 (p. 134) pour obtenir un exemple complet de la procédure.

Comment puis-je modifier une commande avant del'envoyer ?

Vous pouvez modifier une commande avant de l'envoyer en ajoutant un intergiciel personnalisé à laAws\HandlerList d'une Aws\CommandInterface ou d'une Aws\ClientInterface. L'exemplesuivant montre comment ajouter des paramètres de commande personnalisés à une commande avant del'envoyer, principalement en ajoutant des options par défaut. Cet exemple utilise la méthode d'assistanceAws\Middleware::mapCommand.

Pour plus d’informations, consultez la section mapCommand (p. 73).

Qu'est-ce qu'une CredentialsException ?Si vous rencontrez une Aws\Exception\CredentialsException lors de l’utilisation du kit AWS SDKfor PHP, cela signifie qu’aucune information d’identification n’a été fournie au kit SDK et que ce derniern’est pas parvenu à trouver des informations d’identification dans l’environnement.

Si vous instanciez un client sans information d’identification, le kit SDK tente de trouver des informationsd’identification à la première exécution d’une opération de service. Il effectue d'abord une recherchedans des variables d'environnement spécifiques, puis cherche les informations d'identification du profild'instance, uniquement disponibles sur des instances Amazon EC2 configurées. En l'absence d'informationd'identification, une Aws\Exception\CredentialsException est levée.

Si vous rencontrez cette erreur et que vous prévoyez d’utiliser les informations d’identification du profild’instance, veillez à ce que l’instance Amazon EC2 sur laquelle le kit SDK est exécutée soit configuréeavec un rôle IAM approprié.

Si vous rencontrez cette erreur et que vous ne prévoyez pas d’utiliser les informations d’identification duprofil d’instance, veillez à fournir des informations d’identification correctes au kit SDK.

Pour plus d’informations, consultez la section Informations d’identification pour le kit AWS SDK pour PHPversion 3 (p. 42).

Le kit AWS SDK for PHP fonctionne-t-il sur HHVM ?Le kit AWS SDK for PHP ne s'exécute actuellement pas sur HHVM et ce jusqu'à la résolution du problèmeconcernant la sémantique yield dans HHVM.

294

https://github.com/facebook/hhvm/issues/6807

https://github.com/facebook/hhvm/issues/6807

AWS SDK pour PHP Manuel du développeurComment désactiver SSL ?

Comment désactiver SSL ?Vous pouvez désactiver SSL en définissant le paramètre scheme d'une méthode de fabrique de client sur« http ». Il est important de noter que tous les services ne prennent pas en charge l'accès http. Consultezla section Régions et points de terminaison AWS du Amazon Web Services General Reference pourobtenir la liste des régions, points de terminaison et schémas pris en charge.

$client = new Aws\DynamoDb\DynamoDbClient([ 'version' => '2012-08-10', 'region' => 'us-west-2', 'scheme' => 'http']);

Warning

SSL impose que toutes les données soient chiffrées et requiert davantage de paquets TCP quele protocole TCP seul pour établir une liaison de connexion. La désactivation de SSL peut doncse traduire par une légère amélioration des performances. Cependant, une fois SSL désactivé,toutes les données sont envoyées sur le réseau non chiffrées. Avant de désactiver SSL, prenezen compte les répercussions de sa désactivation sur la sécurité et le risque d'écoute illicite sur leréseau.

Que dois-je faire face à une « erreur d'analyse » ?Le moteur PHP génère des erreurs d'analyse lorsqu'il rencontre une syntaxe qu'il ne comprend pas. Cettesituation se produit quasi systématiquement lorsque le moteur tente d'exécuter du code écrit pour une autreversion de PHP.

Si vous rencontrez une erreur d'analyse, vérifiez votre système et assurez-vous qu'il est conforme auxExigences et recommandations pour le kit AWS SDK pour PHP version 3 (p. 4) du kit SDK.

Pourquoi le client Amazon S3 décompresse-t-il lesfichiers gzipped ?

Certains gestionnaires HTTP, dont le gestionnaire HTTP Guzzle 6 par défaut, gonflent le corps desréponses compressées par défaut. Vous pouvez remplacer ce comportement en définissant l’option HTTPdecode_content (p. 33) sur false. Pour des raisons de rétrocompatibilité, cette valeur par défaut ne peutpas être modifiée, mais nous vous recommandons de désactiver le décodage du contenu au niveau duclient S3.

Consultez la section decode_content (p. 33) pour obtenir un exemple de désactivation du décodage decontenu automatique.

Comment désactiver la signature du corps dansAmazon S3 ?

Vous pouvez désactiver la signature du corps en définissant le paramètre ContentSHA256 de l'objet decommande sur Aws\Signature\S3SignatureV4::UNSIGNED_PAYLOAD. Le kit AWS SDK for PHP

295


AWS SDK pour PHP Manuel du développeurComment le schéma de nouvelle tentativeest-il géré dans le kit AWS SDK for PHP ?

l'utilisera ensuite comme en-tête « x-amz-content-sha-256 » et comme total de contrôle du corps dans lademande canonique.

$s3Client = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-standard']);

$params = [ 'Bucket' => 'foo', 'Key' => 'baz', 'ContentSHA256' => Aws\Signature\S3SignatureV4::UNSIGNED_PAYLOAD];

// Using operation methods creates command implicitly$result = $s3Client->putObject($params);

// Using commands explicitly.$command = $s3Client->getCommand('PutObject', $params);$result = $s3Client->execute($command);

Comment le schéma de nouvelle tentative est-ilgéré dans le kit AWS SDK for PHP ?

Le kit AWS SDK for PHP possède un RetryMiddleware qui gère le comportement de nouvelle tentative.En ce qui concerne les codes de statut HTTP 5xx pour les erreurs de serveur, le kit SDK lance unenouvelle tentative sur 500, 502, 503 et 504.

Les exceptions de limitation, y compris RequestLimitExceeded, Throttling,ProvisionedThroughputExceededException, ThrottlingException, RequestThrottled etBandwidthLimitExceeded, sont également gérées avec les nouvelles tentatives.

Le kit AWS SDK for PHP intègre en outre un délai exponentiel avec un algorithme d'interruption etd'instabilité dans le schéma de nouvelle tentative. De plus, le comportement de nouvelle tentative pardéfaut est configuré comme 3 pour tous les services, à l’exception de Amazon DynamoDB, qui est luiconfiguré comme 10.

Comment gérer les exceptions avec des codesd'erreur ?

Outre les classes personnalisées Exception du kit AWS SDK for PHP, chaque client de service AWSdispose de sa propre classe d’exception qui hérite de AwsExceptionAwsException. Vous pouvez affinerles types d'erreur à identifier avec les erreurs d'API spécifiques répertoriées dans la section Errors dechaque méthode.

Des informations sur les codes d’erreur sont disponibles avec getAwsErrorCode () de Aws\Exception\AwsException.

$sns = new \Aws\Sns\SnsClient([ 'region' => 'us-west-2', 'version' => 'latest',]);

296

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.Exception.AwsException.html

https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.Exception.AwsException.html#_getAwsErrorCode

AWS SDK pour PHP Manuel du développeurComment gérer les exceptions avec des codes d'erreur ?

try { $sns->publish([ // parameters ... ]); // Do something} catch (SnsException $e) { switch ($e->getAwsErrorCode()) { case 'EndpointDisabled': case 'NotFound': // Do something break; }}

297


GlossaireVersion de l'API

Les services disposent d'une ou de plusieurs versions d'API et la version que vous utilisez détermineles opérations et les paramètres valides. Le format des versions d'API est similaire à celui d'unedate. Par exemple, la dernière version d’API pour Amazon S3 est 2006-03-01. Spécifiez uneversion (p. 42) lorsque vous configurez un objet client.

Client

Les objets client permettent d'exécuter des opérations pour un service. Chaque service pris en chargedans le kit SDK est associé à un objet client. Les objets client ont des méthodes qui correspondentchacune aux opérations de service. Consultez le guide d’utilisation de base (p. 7) pour en savoir plussur la création et l’utilisation d’objets client.

Commande

Les objets de commande encapsulent l'exécution d'une opération. Lorsque vous suivez les modèlesd’utilisation de base (p. 7) du kit SDK, vous n’utilisez pas directement les objets de commande.Vous pouvez accéder aux objets de commande à l'aide de la méthode getCommand() d'un clientafin de pouvoir utiliser les fonctions avancées du kit SDK, telles que les demandes simultanéeset le traitement par lots. Consultez le guide Objets de commande dans le kit AWS SDK pour PHPversion 3 (p. 60) pour plus d’informations.

Informations d'identification

Pour interagir avec les services AWS, authentifiez-vous auprès du service concerné à l'aide de vosinformations d'identification ou de clés d'accès AWS. Vos clés d’accès se composent de deux parties :votre ID de clé d’accès, qui identifie votre compte, et votre clé d’accès secrète, utilisée pour créer dessignatures lors de l’exécution d’opérations. Fournissez vos informations d'identification (p. 42) lorsquevous configurez un objet client.

Gestionnaire

Un gestionnaire est une fonction qui transforme une commande et une requête en un résultat. Il envoiegénéralement des requêtes HTTP. Les gestionnaires peuvent comporter des intergiciels, qui renforcentleur comportement. Un gestionnaire est une fonction qui accepte un Aws\CommandInterface etun Psr\Http\Message\RequestInterface, et renvoie une promesse exécutée avec un Aws\ResultInterface ou rejetée avec une raison Aws\Exception\AwsException.

JMESPath

JMESPath est un langage de requête spécifique aux données JSON. Le kit AWS SDK for PHP utiliseles expressions JMESPath pour interroger les structures de données PHP. Les expressions JMESPathpeuvent être utilisées directement sur les objets Aws\Result et Aws\ResultPaginator via laméthode search($expression).

Intergiciel

Un intergiciel est un type spécial de fonction de haut niveau qui augmente le comportement detransfert d'une commande et délègue la tâche à un gestionnaire « suivant ». Les fonctions d'intergicielacceptent un Aws\CommandInterface et un Psr\Http\Message\RequestInterface, etrenvoient une promesse exécutée avec un Aws\ResultInterface ou rejetée avec une raison Aws\Exception\AwsException.

Opération

Désigne une opération unique au sein de l'API d'un service (par exemple : CreateTable pourDynamoDB, RunInstances pour Amazon EC2). Dans le kit SDK, les opérations sont exécutéesen appelant une méthode du même nom sur l'objet client du service correspondant. L'exécution

298

https://aws.amazon.com/developers/access-keys/



d'une opération implique de préparer et d'envoyer une demande HTTP au service, puis d'en analyserla réponse. Ce processus d’exécution d’une opération est extrait par le kit SDK via les objets decommande.

Programme de pagination

Certaines opérations de service AWS sont paginées et répondent avec des résultats tronqués. Parexemple, l'opération ListObjects d'Amazon S3 ne renvoie que 1000 objets maximum à la fois. Lesopérations telles que celles-ci nécessitent d’effectuer les demandes suivantes avec des paramètres dejeton (ou marqueur) pour récupérer l’ensemble des résultats. Les programmes de pagination sont unefonction du kit SDK qui agissent comme une abstraction de ce processus afin de faciliter l’utilisationdes API paginées pour les développeurs. Ils sont accessibles via la méthode getPaginator() duclient. Consultez le guide Programmes de pagination dans le kit AWS SDK pour PHP version 3 (p. 80)pour plus d’informations.

Promesse

Une promesse représente le résultat final d'une opération asynchrone. Le principal moyen d'interagiravec une promesse réside dans l'utilisation de sa méthode then, qui enregistre les rappels pourrecevoir la valeur finale d'une promesse ou la raison pour laquelle la promesse ne peut pas êtreexécutée.

Région

Les services sont pris en charge dans une ou plusieurs régions géographiques. Les services peuventavoir différents points de terminaison/différentes URL dans chaque région afin de réduire la latencedes données dans vos applications. Fournissez une région (p. 39) lors de la configuration d'un objetclient, pour permettre au kit SDK de déterminer le point de terminaison à utiliser avec le service.

Kit SDK

Le terme « SDK » peut désigner la bibliothèque du kit AWS SDK for PHP dans son ensemble, maiségalement la classe Aws\Sdk (documents), qui agit comme une fabrique pour les objets clientsde chaque service. La classe Sdk vous permet également de fournir un ensemble de valeurs deconfiguration globale (p. 24) appliquées à tous les objets clients qu'elle crée.

Service

Terme générique utilisé pour désigner tout service AWS (par ex., Amazon S3, Amazon DynamoDB,AWS OpsWorks, etc.). Chaque service est associé, dans le kit SDK, à un objet client prenant encharge une ou plusieurs versions d’API. Chaque service dispose également d’une ou de plusieursopérations qui composent son API. Les services sont pris en charge dans une ou plusieurs régions.

Signature

Lors de l'exécution d'opérations, le kit SDK utilise vos informations d'identification pour créer unesignature numérique de votre demande. Le service vérifie ensuite la signature avant de traiter votredemande. Le processus de signature est encapsulé par le kit SDK et s'effectue automatiquement àl'aide des informations d'identification configurées pour le client.

Programme d'attente

Les programmes d’attente sont une fonction du kit SDK permettant de faciliter l’utilisation desopérations modifiant l’état d’une ressource. Ces programmes sont cohérents à terme ou de natureasynchrone. Par exemple, l’opération Amazon DynamoDBCreateTable renvoie une réponseimmédiatement, mais le tableau peut ne pas être prêt à y accéder pendant plusieurs secondes.L'exécution d'un programme d'attente vous permet d'attendre qu'une ressource passe à un étatspécifique en mettant en veille et en interrogeant l'état de la ressource. Les programmes d'attente sontaccessibles via la méthode waitUntil() du client. Consultez le guide Programmes d’attente dans lekit AWS SDK pour PHP version 3 (p. 82) pour en savoir plus.

Pour connaître la terminologie AWS la plus récente, consultez le Glossaire AWS dans le documentRéférences générales AWS.

299


https://docs.aws.amazon.com/aws-sdk-php/v3/api//class-Aws.Sdk.html

https://docs.aws.amazon.com/general/latest/gr/glos-chap.html

AWS SDK pour PHP Manuel du développeurForum PHP SDK

Ressources supplémentairesLes liens suivants fournissent des ressources supplémentaires que vous pouvez utiliser avec le kit SDKpour PHP version 3.

Forum PHP SDKVous pouvez trouver des questions et discussions sur des questions d’intérêt pour les utilisateurs du kitSDK pour PHP dans le forum PHP SDK.

Kit SDK PHP v3 et Manuel du développeur surGitHub

Il existe plusieurs référentiels sur GitHub pour le kit AWS SDK for PHP.

• Le kit AWS SDK for PHP actuel est disponible dans le référentiel du kit SDK.• Le Manuel du développeur SDK pour PHP est disponible au format texte restructuré dans son propre

référentiel de documentation.• Le code exemple inclus dans ce guide est disponible dans le référentiel d’exemple de code SDK.

PHP SDK sur GitterVous pouvez également trouver des questions et des discussions sur le kit AWS SDK for PHP dans lacommunauté PHP SDK sur Gitter.

300

https://forums.aws.amazon.com/forum.jspa?forumID=80

https://github.com/aws/aws-sdk-php

https://github.com/awsdocs/aws-php-developers-guide


https://gitter.im/aws/aws-sdk-php


Historique du documentL'historique suivant décrit les modifications importantes apportées depuis la dernière version du documentAWS SDK for PHP Developer Guide.

Dernière mise à jour majeure apportée à la documentation : 9 mai 2018

Modification Description Date de parution

Exemples Secrets Manager Ajout d'autres exemples deservice

27 mars 2019

Découverte du points determinaison

Configuration de la découvertede points de terminaison

15 février 2019

Amazon CloudFront Ajout d'autres exemples deservice

25 janvier 2019

Fonctions de service Métriques SDK 11 janvier 2018

Amazon Kinesis, Amazon SNS Ajout d'autres exemples deservice

14 décembre 2018

Exemples Amazon SES Ajout d'autres exemples deservice

5 octobre 2018

Exemples AWS KMS Ajout d'autres exemples deservice

8 août 2018

Informations d'identification Clarification et simplificationdu guide des informationsd'identification

30 juin 2018

Exemples MediaConvert Ajout d'autres exemples deservice

15 juin 2018

Nouvelle présentation Web Documentation changée en styleAWS

9 mai 2018

Chiffrement Amazon S3 Chiffrement côté client 17 novembre 2017

Amazon S3, Amazon SQS Ajout d'autres exemples deservice

26 mars 2017

Amazon S3, IAM, Amazon EC2 Ajout d'autres exemples deservice

17 mars 2017

Ajout d'informationsd'identification

Ajout de la prise en charged'AssumeRole et ini

17 janvier 2017

Exemples S3 Publications multi-région et pré-signées S3

18 mars 2016

Amazon ES et AmazonCloudSearch

Ajout d'autres exemples deservice

28 décembre 2015

301


Modification Description Date de parution

Ligne de commande Ajout de paramètres decommande

13 août 2015

Fonctions de service Ajout de fonctions de servicepour S3 et AWS

30 avril 2015

Nouvelle version SDK Publication de la version 3 du kitAWS SDK for PHP

26 mai 2015

302

AWS SDK pour PHP...AWS SDK pour PHP Manuel du développeur Amazon's trademarks and trade dress may...

Documents

Transcript of AWS SDK pour PHP...AWS SDK pour PHP Manuel du développeur Amazon's trademarks and trade dress may...