',
'Time' => time()
],
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# Utilisation d'actions d'alarme avec les CloudWatch alarmes Amazon avec AWS SDK pour PHP la version 3
Utilisez des actions d'alarme pour créer des alarmes qui arrêtent, mettent fin, redémarrent ou restaurent automatiquement vos EC2 instances Amazon. Vous pouvez utiliser les actions d'arrêt ou de mise hors service quand vous n'avez plus besoin qu'une instance s'exécute. Vous pouvez utiliser les actions de redémarrage et de récupération pour redémarrer automatiquement ces instances.
Les exemples suivants montrent comment :
+ Activez les actions pour les alarmes spécifiées à l'aide de [EnableAlarmActions](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#enablealarmactions).
+ Désactivez les actions pour les alarmes spécifiées à l'aide de [DisableAlarmActions](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#disablealarmactions).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Activer des actions d'alerte
**Importations**
```
require 'vendor/autoload.php';
use Aws\CloudWatch\CloudWatchClient;
use Aws\Exception\AwsException;
```
**Exemple de code**
```
function enableAlarmActions($cloudWatchClient, $alarmNames)
{
try {
$result = $cloudWatchClient->enableAlarmActions([
'AlarmNames' => $alarmNames
]);
if (isset($result['@metadata']['effectiveUri'])) {
return 'At the effective URI of ' .
$result['@metadata']['effectiveUri'] .
', actions for any matching alarms have been enabled.';
} else {
return'Actions for some matching alarms ' .
'might not have been enabled.';
}
} catch (AwsException $e) {
return 'Error: ' . $e->getAwsErrorMessage();
}
}
function enableTheAlarmActions()
{
$alarmNames = array('my-alarm');
$cloudWatchClient = new CloudWatchClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-08-01'
]);
echo enableAlarmActions($cloudWatchClient, $alarmNames);
}
// Uncomment the following line to run this code in an AWS account.
// enableTheAlarmActions();
```
## Désactiver des actions d'alerte
**Importations**
```
require 'vendor/autoload.php';
use Aws\CloudWatch\CloudWatchClient;
use Aws\Exception\AwsException;
```
**Exemple de code**
```
function disableAlarmActions($cloudWatchClient, $alarmNames)
{
try {
$result = $cloudWatchClient->disableAlarmActions([
'AlarmNames' => $alarmNames
]);
if (isset($result['@metadata']['effectiveUri'])) {
return 'At the effective URI of ' .
$result['@metadata']['effectiveUri'] .
', actions for any matching alarms have been disabled.';
} else {
return 'Actions for some matching alarms ' .
'might not have been disabled.';
}
} catch (AwsException $e) {
return 'Error: ' . $e->getAwsErrorMessage();
}
}
function disableTheAlarmActions()
{
$alarmNames = array('my-alarm');
$cloudWatchClient = new CloudWatchClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-08-01'
]);
echo disableAlarmActions($cloudWatchClient, $alarmNames);
}
// Uncomment the following line to run this code in an AWS account.
// disableTheAlarmActions();
```
# EC2 Exemples Amazon utilisant la AWS SDK pour PHP version 3
Amazon Elastic Compute Cloud (Amazon EC2) est un service Web qui fournit un hébergement de serveurs virtuels dans le cloud. Il est conçu pour faciliter le cloud computing à l'échelle du Web pour les développeurs en fournissant une capacité de calcul redimensionnable.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
**Topics**
+ [Informations d’identification](#examplecredentials)
+ [Gestion des EC2 instances Amazon](ec2-examples-managing-instances.md)
+ [Utilisation d'adresses IP élastiques](ec2-examples-using-elastic-ip-addresses.md)
+ [Utilisation des régions et des zones de disponibilité](ec2-examples-using-regions-and-zones.md)
+ [Utilisation de paires de clés](ec2-examples-working-with-key-pairs.md)
+ [Utilisation des groupes de sécurité](ec2-examples-using-security-groups.md)
# Gestion des EC2 instances Amazon à l'aide de la AWS SDK pour PHP version 3
Les exemples suivants montrent comment :
+ Décrivez EC2 les instances Amazon utilisant [DescribeInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeinstances).
+ Activez la surveillance détaillée d'une instance en cours d'exécution à l'aide de [MonitorInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#monitorinstances).
+ Désactivez la surveillance d'une instance en cours d'exécution à l'aide de [UnmonitorInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#unmonitorinstances).
+ Démarrez une AMI basée sur Amazon EBS que vous avez précédemment arrêtée d'utiliser. [StartInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#startinstances)
+ Arrêtez l'utilisation d'une instance basée sur Amazon EBS. [StopInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#stopinstances)
+ Demandez le redémarrage d'une ou de plusieurs instances à l'aide de [RebootInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#rebootinstances).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Décrire des instances
**Importations**
```
require 'vendor/autoload.php';
use Aws\Ec2\Ec2Client;
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeInstances();
echo "Instances: \n";
foreach ($result['Reservations'] as $reservation) {
foreach ($reservation['Instances'] as $instance) {
echo "InstanceId: {$instance['InstanceId']} - {$instance['State']['Name']} \n";
}
}
```
## Activer et désactiver la surveillance
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$instanceIds = ['InstanceID1', 'InstanceID2'];
$monitorInstance = 'ON';
if ($monitorInstance == 'ON') {
$result = $ec2Client->monitorInstances([
'InstanceIds' => $instanceIds
]);
} else {
$result = $ec2Client->unmonitorInstances([
'InstanceIds' => $instanceIds
]);
}
var_dump($result);
```
## lancer et arrêter une instance ;
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$action = 'START';
$instanceIds = ['InstanceID1', 'InstanceID2'];
if ($action == 'START') {
$result = $ec2Client->startInstances([
'InstanceIds' => $instanceIds,
]);
} else {
$result = $ec2Client->stopInstances([
'InstanceIds' => $instanceIds,
]);
}
var_dump($result);
```
## Redémarrer une instance
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$instanceIds = ['InstanceID1', 'InstanceID2'];
$result = $ec2Client->rebootInstances([
'InstanceIds' => $instanceIds
]);
var_dump($result);
```
# Utilisation d'adresses IP élastiques avec Amazon EC2 version 3 AWS SDK pour PHP
Une EIP est une adresse IP statique conçue pour le cloud computing. Une adresse IP élastique est associée à votre Compte AWS. Il s'agit d'une adresse IP publique accessible depuis Internet. Si votre instance ne dispose pas d'une adresse IP publique, vous pouvez lui associer une adresse IP Elastic pour établir la communication avec Internet.
Les exemples suivants montrent comment :
+ Décrivez une ou plusieurs de vos instances en utilisant [DescribeInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeinstances).
+ Obtenez une adresse IP élastique à l'aide de [AllocateAddress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#allocateaddress).
+ Associez une adresse IP élastique à une instance à l'aide de [AssociateAddress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#associateaddress).
+ Libérez une adresse IP élastique à l'aide de [ReleaseAddress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#releaseaddress).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Décrire une instance
**Importations**
```
require 'vendor/autoload.php';
use Aws\Ec2\Ec2Client;
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeInstances();
echo "Instances: \n";
foreach ($result['Reservations'] as $reservation) {
foreach ($reservation['Instances'] as $instance) {
echo "InstanceId: {$instance['InstanceId']} - {$instance['State']['Name']} \n";
}
}
```
## Attribuer et associer une adresse
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$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);
```
## Publier une adresse
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$associationID = 'AssociationID';
$allocationID = 'AllocationID';
$result = $ec2Client->disassociateAddress([
'AssociationId' => $associationID,
]);
$result = $ec2Client->releaseAddress([
'AllocationId' => $allocationID,
]);
var_dump($result);
```
# Utilisation des régions et des zones de disponibilité pour Amazon EC2 avec AWS SDK pour PHP la version 3
Amazon EC2 est hébergé sur plusieurs sites dans le monde entier. Ces emplacements sont composés de AWS régions et de zones de disponibilité. Chaque région est une zone géographique distincte, avec plusieurs emplacements isolés appelés zones de disponibilité. Amazon EC2 permet de placer des instances et des données sur plusieurs sites.
Les exemples suivants montrent comment :
+ Décrivez les zones de disponibilité que vous pouvez utiliser [DescribeAvailabilityZones](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeavailabilityzones).
+ Décrivez les AWS régions que vous pouvez actuellement utiliser [DescribeRegions](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeregions).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Décrire les zones de disponibilité
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeAvailabilityZones();
var_dump($result);
```
## Décrire les régions
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeRegions();
var_dump($result);
```
# Utilisation des paires de EC2 clés Amazon avec AWS SDK pour PHP la version 3
Amazon EC2 utilise le chiffrement à 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 destinataire utilise la clé privée pour déchiffrer les données. La clé publique et la clé privée constituent une paire de clés.
Les exemples suivants montrent comment :
+ Créez une paire de clés RSA 2048 bits à l'aide de. [CreateKeyPair](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#createkeypair)
+ Supprimez une paire de clés spécifiée à l'aide de [DeleteKeyPair](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#deletekeypair).
+ Décrivez une ou plusieurs de vos paires de clés en utilisant [DescribeKeyPairs](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describekeypairs).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Création d’une paire de clés
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$keyPairName = 'my-keypair';
$result = $ec2Client->createKeyPair(array(
'KeyName' => $keyPairName
));
// 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 SSH
chmod($saveKeyLocation, 0600);
```
## Supprimer une paire de clés
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$keyPairName = 'my-keypair';
$result = $ec2Client->deleteKeyPair(array(
'KeyName' => $keyPairName
));
var_dump($result);
```
## Décrire des paires de clés
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeKeyPairs();
var_dump($result);
```
# Utilisation des groupes de sécurité dans Amazon EC2 avec AWS SDK pour PHP la version 3
Un groupe EC2 de sécurité Amazon agit comme un pare-feu virtuel qui contrôle le trafic d'une ou de plusieurs instances. Vous ajoutez des règles à chaque groupe de sécurité pour autoriser le trafic vers ou depuis ses instances associées. Vous pouvez modifier les règles pour un groupe de sécurité à la fois. Les nouvelles règles sont automatiquement appliquées à toutes les instances associées au groupe de sécurité.
Les exemples suivants montrent comment :
+ Décrivez un ou plusieurs de vos groupes de sécurité en utilisant [DescribeSecurityGroups](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describesecuritygroups).
+ Ajoutez une règle d'entrée à un groupe de sécurité à l'aide [AuthorizeSecurityGroupIngress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#authorizesecuritygroupingress)de.
+ Créez un groupe de sécurité à l'aide de [CreateSecurityGroup](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#createsecuritygroup).
+ Supprimez un groupe de sécurité à l'aide de [DeleteSecurityGroup](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#deletesecuritygroup).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Décrire des groupes de sécurité
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeSecurityGroups();
var_dump($result);
```
## Ajouter une règle d'entrée
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->authorizeSecurityGroupIngress(array(
'GroupName' => 'string',
'SourceSecurityGroupName' => 'string'
));
var_dump($result);
```
## Création d’un groupe de sécurité
**Importations**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
// 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**
```
require 'vendor/autoload.php';
```
**Exemple de code**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$securityGroupId = 'my-security-group-id';
$result = $ec2Client->deleteSecurityGroup([
'GroupId' => $securityGroupId
]);
var_dump($result);
```
# Signature d'une demande OpenSearch de recherche Amazon Service avec AWS SDK pour PHP la version 3
Amazon OpenSearch Service est un service géré qui facilite le déploiement, l'exploitation et le dimensionnement d'Amazon OpenSearch Service, un moteur de recherche et d'analyse open source populaire. OpenSearch Le service offre un accès direct à l'API Amazon OpenSearch Service. Cela signifie que les développeurs peuvent utiliser les outils qu'ils connaissent bien, ainsi que des options de sécurité robustes. De nombreux clients Amazon OpenSearch Service prennent en charge la signature des demandes, mais si vous utilisez un client qui ne le fait pas, vous pouvez signer des demandes PSR-7 arbitraires avec les fournisseurs d'informations d'identification et les signataires intégrés du. AWS SDK pour PHP
Les exemples suivants montrent comment :
+ Signez une demande avec le protocole de AWS signature à l'aide de [SignatureV4](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Signature.SignatureV4.html#_signRequest).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Signature d'une demande OpenSearch de service
OpenSearch Le service utilise [la version 4 de Signature](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). Cela signifie que vous devez signer les demandes en fonction du nom de signature du service (`es`dans ce cas) et de la AWS région de votre domaine de OpenSearch service. La liste complète des régions prises en charge par le OpenSearch service est disponible [sur la page AWS Régions et points de terminaison](https://docs.aws.amazon.com/general/latest/gr/rande.html) du Référence générale d'Amazon Web Services. Toutefois, dans cet exemple, nous signons des demandes relatives à un domaine de OpenSearch service de la `us-west-2` région.
Vous devez fournir des informations d'identification, ce que vous pouvez faire soit avec la chaîne de fournisseurs par défaut du SDK, soit avec toute forme d'informations d'identification décrite dans [Informations d'identification pour la AWS SDK pour PHP version 3](guide_credentials.md). Vous aurez également besoin d'une [demande PSR-7](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Psr.Http.Message.RequestInterface.html) (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);
```
# Gestion des identités et des accès AWS exemples utilisant la AWS SDK pour PHP version 3
Gestion des identités et des accès AWS (IAM) est un service Web qui permet aux clients d'Amazon Web Services de gérer les utilisateurs et les autorisations des utilisateurs dans AWS. Le service est destiné aux organisations ayant plusieurs utilisateurs ou des systèmes dans le cloud qui utilisent AWS des produits. Avec IAM, vous pouvez gérer de manière centralisée les utilisateurs, les informations d'identification de sécurité telles que les clés d'accès et les autorisations qui contrôlent les AWS ressources auxquelles les utilisateurs peuvent accéder.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
**Topics**
+ [Informations d’identification](#examplecredentials)
+ [Gestion des clés d'accès IAM](iam-examples-managing-access-keys.md)
+ [Gestion des utilisateurs IAM](iam-examples-managing-users.md)
+ [Utilisation d'alias de compte IAM](iam-examples-using-account-aliases.md)
+ [Utilisation des politiques IAM](iam-examples-working-with-policies.md)
+ [Utilisation des certificats de serveur IAM](iam-examples-working-with-certs.md)
# Gestion des clés d'accès IAM avec AWS SDK pour PHP la version 3
Les utilisateurs ont besoin de leurs propres clés d'accès pour effectuer des appels programmatiques. AWS Pour répondre à ce besoin, vous pouvez créer, modifier, afficher ou faire pivoter des clés d'accès (clé d'accès IDs et clés d'accès secrètes) pour les utilisateurs IAM. Par défaut, lorsque vous créez une clé d'accès, son état est Active. Cela signifie que l'utilisateur peut se servir de la clé d'accès pour effectuer des appels d'API.
Les exemples suivants montrent comment :
+ Créez une clé d'accès secrète et l'ID de clé d'accès correspondant à l'aide de [CreateAccessKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createaccesskey).
+ Renvoie des informations sur la clé d'accès IDs associée à un utilisateur IAM utilisant [ListAccessKeys](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listaccesskeys).
+ Récupérez des informations sur la date à laquelle une clé d'accès a été utilisée pour la dernière fois en utilisant [GetAccessKeyLastUsed](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getaccesskeylastused).
+ Modifiez le statut d'une clé d'accès d'Actif à Inactif, ou vice versa, en utilisant [UpdateAccessKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateaccesskey).
+ Supprimez une paire de clés d'accès associée à un utilisateur IAM à l'aide [DeleteAccessKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteaccesskey)de.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Créer une clé d'accès
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$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 "AccessKey " . $keyID . " created on " . $createDate . "
";
echo "Username: " . $userName . "
";
echo "Status: " . $status . "
";
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Répertorier des clés d'accès
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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ès
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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ès
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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());
}
```
## Supprimer une clé d'accès
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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 la AWS SDK pour PHP version 3
Un utilisateur IAM est une entité que vous créez AWS pour représenter la personne ou le service avec AWS lequel il interagit. Un utilisateur se AWS compose d'un nom et d'informations d'identification.
Les exemples suivants montrent comment :
+ Créez un nouvel utilisateur IAM à l'aide [CreateUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createuser)de.
+ Répertoriez les utilisateurs IAM en utilisant [ListUsers](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listusers).
+ Mettez à jour un utilisateur IAM à l'aide [UpdateUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateuser)de.
+ Récupérez des informations sur un utilisateur IAM à l'aide [GetUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getuser)de.
+ Supprimez un utilisateur IAM à l'aide [DeleteUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteuser)de.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Créer un utilisateur IAM
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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 les utilisateurs IAM
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->listUsers();
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Mettre à jour un utilisateur IAM
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->updateUser([
// 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 IAM
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->getUser([
'UserName' => 'string',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Supprimer un utilisateur IAM
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->deleteUser([
// UserName is required
'UserName' => 'string'
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# Utilisation d'alias de compte IAM avec AWS SDK pour PHP la version 3
Si vous souhaitez que l'URL de votre page de connexion contienne le nom de votre entreprise ou un autre identifiant convivial au lieu de votre Compte AWS identifiant, vous pouvez créer un alias pour votre Compte AWS identifiant. Si vous créez un Compte AWS alias, l'URL de votre page de connexion change pour intégrer l'alias.
Les exemples suivants montrent comment :
+ Créez un alias à l'aide de [CreateAccountAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createaccountalias).
+ Répertoriez l'alias associé à l' Compte AWS utilisation [ListAccountAliases](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listaccountaliases).
+ Supprimez un alias à l'aide de [DeleteAccountAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteaccountalias).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Créer un alias
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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());
}
```
## Répertorier des alias de compte
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->listAccountAliases();
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Supprimer un alias
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->deleteAccountAlias([
// AccountAlias is required
'AccountAlias' => 'string',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# Utilisation des politiques IAM avec la AWS SDK pour PHP version 3
Vous devez accorder des autorisations à un utilisateur en créant une stratégie. Une stratégie est un document qui répertorie les actions qu'un utilisateur peut effectuer ainsi que les ressources que ces actions peuvent affecter. Les actions ou ressources qui ne sont pas explicitement autorisées sont refusées par dé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.
Les exemples suivants montrent comment :
+ Créez une politique gérée à l'aide de [CreatePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createpolicy).
+ Attachez une politique à un rôle à l'aide de [AttachRolePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachrolepolicy).
+ Attachez une politique à un utilisateur en utilisant [AttachUserPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachuserpolicy).
+ Attachez une politique à un groupe à l'aide de [AttachGroupPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachgrouppolicy).
+ Supprimez une politique de rôle à l'aide de [DetachRolePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachrolepolicy).
+ Supprimez une politique utilisateur à l'aide de [DetachUserPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachuserpolicy).
+ Supprimez une politique de groupe à l'aide de [DetachGroupPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachgrouppolicy).
+ Supprimez une politique gérée à l'aide de [DeletePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deletepolicy).
+ Supprimez une politique de rôle à l'aide de [DeleteRolePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleterolepolicy).
+ Supprimez une politique utilisateur à l'aide de [DeleteUserPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteuserpolicy).
+ Supprimez une politique de groupe à l'aide de [DeleteGroupPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deletegrouppolicy).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Créer une politique
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
$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 politique à un rôle
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
$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 politique à un utilisateur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
$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());
}
```
## Associer une politique à un groupe
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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());
}
```
## Détacher une politique utilisateur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->detachUserPolicy([
// 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 politique de groupe
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->detachGroupPolicy([
// 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());
}
```
## Supprimer une politique
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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 politique de rôle
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->deleteRolePolicy([
// 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 politique utilisateur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->deleteUserPolicy([
// 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 politique de groupe
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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 de certificats de serveur IAM avec AWS SDK pour PHP la version 3
Pour activer les connexions HTTPS à votre site Web ou à votre application AWS, vous avez besoin d'un certificat de SSL/TLS serveur. Pour utiliser un certificat que vous avez obtenu auprès d'un fournisseur externe avec votre site Web ou votre application AWS, vous devez télécharger le certificat dans IAM ou l'importer dans AWS Certificate Manager.
Les exemples suivants montrent comment :
+ Répertoriez les certificats stockés dans IAM à l'aide [ListServerCertificates](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listservercertificates)de.
+ Récupérez les informations relatives à un certificat à l'aide de [GetServerCertificate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getservercertificate).
+ Mettez à jour un certificat à l'aide de [UpdateServerCertificate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateservercertificate).
+ Supprimez un certificat à l'aide de [DeleteServerCertificate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteservercertificate).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Lister les certificats de serveur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
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 serveur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->getServerCertificate([
// ServerCertificateName is required
'ServerCertificateName' => 'string',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Mettre à jour un certificat de serveur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->updateServerCertificate([
// ServerCertificateName is required
'ServerCertificateName' => 'string',
'NewServerCertificateName' => 'string',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Supprimer un certificat de serveur
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Exemple de code**
```
$client = new IamClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2010-05-08'
]);
try {
$result = $client->deleteServerCertificate([
// ServerCertificateName is required
'ServerCertificateName' => 'string',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# AWS Key Management Service exemples utilisant la AWS SDK pour PHP version 3
AWS Key Management Service (AWS KMS) est un service géré qui vous permet de créer et de contrôler facilement les clés de chiffrement utilisées pour chiffrer vos données. Pour plus d'informations AWS KMS, consultez la [documentation Amazon KMS](https://aws.amazon.com/documentation/kms/). Que vous écriviez des applications PHP sécurisées ou que vous envoyiez des données à d'autres AWS services, AWS KMS cela vous permet de contrôler qui peut utiliser vos clés et accéder à vos données cryptées.
Tous les exemples de code pour la AWS SDK pour PHP version 3 sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Utilisation de clés](kms-example-keys.md)
+ [Chiffrement et déchiffrement des clés de données](kms-example-encrypt.md)
+ [Utilisation de politiques de clé](kms-example-key-policy.md)
+ [Utilisation d'octrois](kms-example-grants.md)
+ [Utilisation des alias](kms-example-alias.md)
# Utilisation des clés à l'aide de l' AWS KMS API et de la AWS SDK pour PHP version 3
Les principales ressources contenues dans AWS Key Management Service (AWS KMS) sont [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). Vous pouvez utiliser une clé KMS pour chiffrer vos données.
Les exemples suivants montrent comment :
+ Créez une clé KMS client à l'aide de [CreateKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#createkey).
+ Générez une clé de données à l'aide de [GenerateDataKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#generatedatakey).
+ Affichez une clé KMS à l'aide de [DescribeKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#describekey).
+ Obtenez les clés IDs et les ARNS des clés KMS à l'aide [ListKeys](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listkeys)de.
+ Activez les clés KMS à l'aide de [EnableKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#enablekey).
+ Désactivez les clés KMS à l'aide de [DisableKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#disablekey).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation de AWS Key Management Service (AWS KMS), consultez le [manuel du AWS KMS développeur](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Création d'une clé KMS
Pour créer une [clé KMS](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys), utilisez l'[CreateKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html)opération.
**Importations**
```
require 'vendor/autoload.php';
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ées
Pour générer une clé de chiffrement des données, utilisez l'[GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html)opération. Cette opération renvoie des copies en texte brut et chiffrées de la clé de données créée. Spécifiez la clé de données AWS KMS key sous laquelle vous souhaitez générer la clé de données.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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é KMS
Pour obtenir des informations détaillées sur une clé KMS, notamment le nom de ressource Amazon (ARN) et [l'état de la clé](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) KMS, utilisez l'[DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)opération.
`DescribeKey` ne récupère pas les alias. Pour obtenir des alias, utilisez l'[ListAliases](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 ARNs la clé d'une clé KMS
Pour obtenir l'ID et l'ARN de la clé KMS, utilisez l'[ListAliases](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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é KMS
Pour activer une clé KMS désactivée, utilisez l'[EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
try {
$result = $KmsClient->enableKey([
'KeyId' => $keyId,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Désactiver une clé KMS
Pour désactiver une clé KMS, utilisez l'[DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html)opération. La désactivation d'une clé KMS empêche son utilisation.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
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 AWS KMS données à l'aide de la version 3 AWS SDK pour PHP
Les clés de données sont des clés de chiffrement que vous pouvez utiliser pour chiffrer des données, y compris de grandes quantités de données et d'autres clés de chiffrement des données.
Vous pouvez utiliser AWS Key Management Service an's (AWS KMS) [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)pour générer, chiffrer et déchiffrer des clés de données.
Les exemples suivants montrent comment :
+ Chiffrer une clé de données à l’aide d’[Encrypt](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#encrypt).
+ Déchiffrer une clé de données à l’aide de [Decrypt](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#decrypt).
+ Rechiffrez une clé de données avec une nouvelle clé KMS à l'aide de. [ReEncrypt](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#reencrypt)
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation de AWS Key Management Service (AWS KMS), consultez le [manuel du AWS KMS développeur](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Encrypt
L'opération [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) est conçue pour chiffrer des clés de données, mais elle n'est pas fréquemment utilisée. Les [GenerateDataKeyWithoutPlaintext](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html)opérations [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html)et renvoient des clés de données chiffrées. Vous pouvez utiliser `Encypt` cette méthode lorsque vous déplacez des données chiffrées vers une nouvelle AWS région et que vous souhaitez chiffrer leur clé de données à l'aide d'une clé KMS dans la nouvelle région.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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";
}
```
## Decrypt
Pour déchiffrer une clé de données, utilisez l'opération [Decrypt.](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html)
La valeur `ciphertextBlob` que vous spécifiez doit être la valeur du `CiphertextBlob` champ provenant d'une réponse [GenerateDataKey[GenerateDataKeyWithoutPlaintext](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html)](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html), ou [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html).
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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";
}
```
## Rechiffrer
Pour déchiffrer une clé de données chiffrée, puis la rechiffrer immédiatement sous une autre clé KMS, utilisez l'opération. [ReEncrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html) Les opérations sont entièrement effectuées du côté serveur à l'intérieur AWS KMS, de sorte qu'elles n'exposent jamais votre texte brut en dehors de AWS KMS.
La valeur `ciphertextBlob` que vous spécifiez doit être la valeur du `CiphertextBlob` champ provenant d'une réponse [GenerateDataKey[GenerateDataKeyWithoutPlaintext](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html)](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html), ou [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html).
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 politiques AWS KMS clés à l'aide de la AWS SDK pour PHP version 3
Lorsque vous créez une clé KMS [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys), vous déterminez qui peut utiliser et gérer cette clé KMS. Ces autorisations sont contenues dans un document appelé politique de clé. Vous pouvez utiliser la politique clé pour ajouter, supprimer ou modifier des autorisations à tout moment pour une clé KMS gérée par le client, mais vous ne pouvez pas modifier la politique clé pour une clé KMS AWS gérée. Pour plus d'informations, consultez [Authentification et contrôle d'accès pour AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/control-access.html).
Les exemples suivants montrent comment :
+ Répertoriez les noms des principales politiques à l'aide de [ListKeyPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listkeypolicies).
+ Obtenez une politique clé en utilisant [GetKeyPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#getkeypolicy).
+ Définissez une politique clé à l'aide de [PutKeyPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#putkeypolicy).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation de AWS Key Management Service (AWS KMS), consultez le [manuel du AWS KMS développeur](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Répertorier toutes les politiques clés
Pour obtenir les noms des politiques clés pour une clé KMS, utilisez l'`ListKeyPolicies`opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 politique clé
Pour obtenir la politique de clé d'une clé KMS, utilisez l'`GetKeyPolicy`opération.
`GetKeyPolicy` nécessite un nom de politique. À moins que vous n'ayez créé une politique clé lors de la création de la clé KMS, le seul nom de politique valide est le nom par défaut. Pour en savoir plus sur la [politique relative aux clés par défaut](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html), consultez le *guide du AWS Key Management Service développeur*.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab';
$policyName = "default";
try {
$result = $KmsClient->getKeyPolicy([
'KeyId' => $keyId,
'PolicyName' => $policyName
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Définissez une politique clé
Pour établir ou modifier une politique de clé pour une clé KMS, utilisez l'`PutKeyPolicy`opération.
`PutKeyPolicy` nécessite un nom de politique. À moins que vous n'ayez créé une politique clé lors de la création de la clé KMS, le seul nom de politique valide est le nom par défaut. Pour en savoir plus sur la [politique relative aux clés par défaut](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html), consultez le *guide du AWS Key Management Service développeur*.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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*"
],
"Resource": "*" }
]
} '
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
# Utilisation des subventions à l'aide de l' AWS KMS API et de la AWS SDK pour PHP version 3
Un octroi est un autre mécanisme permettant de fournir des autorisations. C'est une alternative à la politique clé. Vous pouvez utiliser des subventions pour accorder un accès à long terme qui permet AWS aux principaux d'utiliser votre AWS Key Management Service (AWS KMS) géré par le client [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). Pour plus d'informations, consultez la section [Subventions AWS KMS dans](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) le *guide du AWS Key Management Service développeur*.
Les exemples suivants montrent comment :
+ Créez une autorisation pour une clé KMS à l'aide de [CreateGrant](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#creategrant).
+ Affichez une autorisation pour une clé KMS à l'aide de [ListGrants](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listgrants).
+ Retirez une subvention pour une clé KMS en utilisant [RetireGrant](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#retiregrant).
+ Révoquez une autorisation pour une clé KMS en utilisant [RevokeGrant](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#revokegrant).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation de AWS Key Management Service (AWS KMS), consultez le [manuel du AWS KMS développeur](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Créer un octroi
Pour créer une subvention pour un AWS KMS key, utilisez l'[CreateGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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";
}
```
## Affichage d’un octroi
Pour obtenir des informations détaillées sur les subventions sur un AWS KMS key, utilisez l'[ListGrants](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListGrants.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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";
}
```
## Retrait d'une subvention
Pour annuler une subvention pour un AWS KMS key, utilisez l'[RetireGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html)opération. Résilier un octroi pour nettoyer une fois que vous avez fini de l'utiliser.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 une subvention
Pour révoquer une subvention accordée à un AWS KMS key, utilisez l'[RevokeGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html)opération. Vous pouvez révoquer un octroi pour refuser explicitement les opérations qui en dépendent.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 d'alias à l'aide de l' AWS KMS API et de la AWS SDK pour PHP version 3
AWS Key Management Service (AWS KMS) fournit un nom d'affichage facultatif pour un alias [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)appelé.
Les exemples suivants montrent comment :
+ Créez un alias à l'aide de [CreateAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#createalias).
+ Affichez un alias à l'aide de [ListAliases](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listaliases).
+ Mettez à jour un alias à l'aide de [UpdateAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#updatealias).
+ Supprimez un alias à l'aide de [DeleteAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#deletealias).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation de AWS Key Management Service (AWS KMS), consultez le [manuel du AWS KMS développeur](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Création d’un alias
Pour créer un alias pour une clé KMS, utilisez l'[CreateAlias](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateAlias.html)opération. L'alias doit être unique dans le compte et dans AWS la région. Si vous créez un alias pour une clé KMS qui possède déjà un alias, `CreateAlias` crée un autre alias pour la même clé KMS. Cette opération ne remplace pas l'alias existant.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 alias
Pour répertorier tous les alias figurant dans l'annonce de l' Compte AWS appelant Région AWS, utilisez l'[ListAliases](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'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";
}
```
## Mettre à jour un alias
Pour associer un alias existant à une autre clé KMS, utilisez l'[UpdateAlias](https://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateAlias.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 alias
Pour supprimer un alias, utilisez l'[DeleteAlias](https://docs.aws.amazon.com/kms/latest/APIReference/API_DeleteAlias.html)opération. La suppression d'un alias n'a aucun effet sur la clé KMS sous-jacente.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$KmsClient = new Aws\Kms\KmsClient([
'profile' => 'default',
'version' => '2014-11-01',
'region' => 'us-east-2'
]);
$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 d'Amazon Kinesis utilisant la version 3 AWS SDK pour PHP
Amazon Kinesis est un AWS service qui collecte, traite et analyse les données en temps réel. Configurez vos flux de données avec Amazon Kinesis Data Streams ou utilisez Amazon Data Firehose pour envoyer des données vers Amazon S3, Service OpenSearch , Amazon Redshift ou Splunk.
Pour plus d'informations sur Kinesis, consultez la documentation [Amazon Kinesis](https://docs.aws.amazon.com/kinesis/index.html).
Tous les exemples de code pour la AWS SDK pour PHP version 3 sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Flux de données Kinesis](kinesis-example-data-stream.md)
+ [Tessons Kinesis](kinesis-example-shard.md)
+ [Flux de diffusion Kinesis Data Firehose](kinesis-firehose-example-delivery-stream.md)
# Création de flux de données à l'aide de l'API Kinesis Data Streams et de AWS SDK pour PHP la version 3
Amazon Kinesis Data Streams vous permet d'envoyer des données en temps réel. Créez un producteur de données avec Kinesis Data Streams qui fournit les données à la destination configurée chaque fois que vous ajoutez des données.
Pour plus d'informations, consultez la section [Création et gestion de flux](https://docs.aws.amazon.com/kinesis/latest/dev/working-with-streams.html.html) dans le manuel Amazon Kinesis Developer Guide.
Les exemples suivants montrent comment :
+ Créez un flux de données à l'aide de [CreateAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#createstream).
+ Obtenez des informations sur un seul flux de données à l'aide de [DescribeStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#describestream).
+ Répertoriez les flux de données existants en utilisant [ListStreams](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#liststreams).
+ Envoyez des données vers un flux de données existant à l'aide de [PutRecord](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#putrecord).
+ Supprimez un flux de données à l'aide de [DeleteStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#deletestream).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon Kinesis Developer Guide, consultez le [Amazon Kinesis Data](https://docs.aws.amazon.com/kinesis/latest/dev/) Streams Developer Guide.
## Création d'un flux de données à l'aide d'un flux de données Kinesis
Établissez un flux de données Kinesis dans lequel vous pouvez envoyer des informations à traiter par Kinesis à l'aide de l'exemple de code suivant. Pour en savoir plus sur [la création et la mise à jour de flux de données](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html), consultez le guide du développeur Amazon Kinesis.
Pour créer un flux de données Kinesis, utilisez l'[CreateStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**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ées
Obtenez des détails sur un flux de données existant à l’aide de l’exemple de code suivant. Par défaut, cela renvoie des informations sur les 10 premières partitions connectées au flux de données Kinesis spécifié. N'oubliez pas `StreamStatus` de vérifier la réponse avant d'écrire des données dans un flux de données Kinesis.
Pour récupérer les informations relatives à un flux de données Kinesis spécifique, utilisez l'[DescribeStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$kinesisClient = new Aws\Kinesis\KinesisClient([
'profile' => 'default',
'version' => '2013-12-02',
'region' => 'us-east-2'
]);
$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";
}
```
## Répertorier les flux de données existants connectés à Kinesis
Répertoriez les 10 premiers flux de données provenant Compte AWS de la AWS région 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'[ListStreams](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$kinesisClient = new Aws\Kinesis\KinesisClient([
'profile' => 'default',
'version' => '2013-12-02',
'region' => 'us-east-2'
]);
try {
$result = $kinesisClient->listStreams();
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Envoyer des données vers un flux de données existant
Une fois qu’un flux de données est créé, utilisez l’exemple suivant pour envoyer des données. Avant d’y envoyer des données, utilisez `DescribeStream` pour vérifier si les données `StreamStatus` sont actives.
Pour écrire un seul enregistrement de données dans un flux de données Kinesis, utilisez l'[PutRecord](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html)opération. Pour écrire jusqu'à 500 enregistrements dans un flux de données Kinesis, utilisez l'[PutRecords](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$kinesisClient = new Aws\Kinesis\KinesisClient([
'profile' => 'default',
'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("ShardID = " . $result["ShardId"] . "
");
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Supprimer un flux de données
Cet exemple indique comment supprimer un flux de données. La suppression d’un flux de données entraîne également la suppression des données envoyées au flux de données. Les flux de données Active Kinesis passent à l'état DELETING jusqu'à ce que la suppression du flux soit terminée. Lorsqu’il est à l’état SUPPRESSION EN COURS, le flux continue à traiter des données.
Pour supprimer un flux de données Kinesis, utilisez l'[DeleteStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$kinesisClient = new Aws\Kinesis\KinesisClient([
'profile' => 'default',
'version' => '2013-12-02',
'region' => 'us-east-2'
]);
$name = "my_stream_name";
try {
$result = $kinesisClient->deleteStream([
'StreamName' => $name,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
# Gérez les fragments de données à l'aide de l'API Kinesis Data Streams et AWS SDK pour PHP de la version 3
Amazon Kinesis Data Streams vous permet d'envoyer des données en temps réel à un terminal. 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 par partition, de manière à utiliser ces exemples pour gérer les données de capacité et de coût de votre flux.
Les exemples suivants montrent comment :
+ Répertoriez les fragments d'un flux à l'aide [ListShards](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#listshards)de.
+ Ajoutez ou réduisez le nombre de partitions dans un flux à l'aide [UpdateShardCount](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#updateshardcount)de.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon Kinesis Data Streams, consultez [le manuel du développeur Amazon Kinesis Data](https://docs.aws.amazon.com/streams/latest/dev/) Streams.
## Répertorier les fragments de flux de données
Répertorier les détails de jusqu’à 100 partitions dans un flux spécifique.
Pour répertorier les partitions d'un flux de données Kinesis, utilisez l'[ListShards](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$kinesisClient = new Aws\Kinesis\KinesisClient([
'profile' => 'default',
'version' => '2013-12-02',
'region' => 'us-east-2'
]);
$name = "my_stream_name";
try {
$result = $kinesisClient->ListShards([
'StreamName' => $name,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Ajouter d'autres fragments de flux de données
Si vous avez besoin de davantage de partitions de flux de données, vous pouvez augmenter le nombre actuel de partitions. Nous vous recommandons de doubler votre nombre de partition en cas d’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 pour l'utilisation de Kinesis Data Streams est calculée par partition. Par conséquent, 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 [UpdateShardCount](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_UpdateShardCount.html)cette opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$kinesisClient = new Aws\Kinesis\KinesisClient([
'profile' => 'default',
'version' => '2013-12-02',
'region' => 'us-east-2'
]);
$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";
}
```
# Création de flux de diffusion à l'aide de l'API Firehose et de la version 3 AWS SDK pour PHP
Amazon Data Firehose vous permet d'envoyer des données en temps réel à d'autres AWS services, notamment Amazon Kinesis Data Streams, Amazon S3, Amazon OpenSearch Service (OpenSearch Service) et Amazon Redshift, ou à Splunk. Créer un producteur de données avec les flux de diffusion pour transférer des données vers la destination configurée chaque fois que vous ajoutez des données.
Les exemples suivants montrent comment :
+ Créez un flux de diffusion à l'aide de [CreateDeliveryStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#createdeliverystream).
+ Obtenez des informations sur un seul flux de diffusion à l'aide de [DescribeDeliveryStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#describedeliverystream).
+ Répertoriez vos flux de diffusion à l'aide de [ListDeliveryStreams](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#listdeliverystreams).
+ Envoyez des données à un flux de diffusion à l'aide de [PutRecord](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#putrecord).
+ Supprimez un flux de diffusion à l'aide de [DeleteDeliveryStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#deletedeliverystream).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon Data Firehose, consultez le manuel du développeur [Amazon Kinesis Data](https://docs.aws.amazon.com/streams/latest/dev/) Firehose.
## Création d'un flux de diffusion à l'aide d'un flux de données Kinesis
Pour établir un flux de diffusion qui place les données dans un flux de données Kinesis existant, utilisez l'[CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html)opération.
Cela permet aux développeurs de migrer les services Kinesis existants vers Firehose.
**Importations**
```
require 'vendor/autoload.php';
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";
$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éation d'un flux de diffusion à l'aide d'un compartiment Amazon S3
Pour établir un flux de diffusion qui place les données dans un compartiment Amazon S3 existant, utilisez l'[CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html)opération.
Indiquez les paramètres de destination, comme indiqué dans la section [Paramètres de destination](https://docs.aws.amazon.com/firehose/latest/dev/create-destination.html). Assurez-vous ensuite d'accorder à Firehose l'accès à votre compartiment Amazon S3, comme décrit dans [Accorder à Kinesis Data Firehose l'accès à une](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3.html) destination Amazon S3.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$firehoseClient = new Aws\Firehose\FirehoseClient([
'profile' => 'default',
'version' => '2015-08-04',
'region' => 'us-east-2'
]);
$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
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Création d'un flux de diffusion à l'aide OpenSearch de Service
Pour établir un flux de diffusion Firehose qui place les données dans un cluster de OpenSearch services, utilisez l'[CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html)opération.
Indiquez les paramètres de destination, comme indiqué dans la section [Paramètres de destination](https://docs.aws.amazon.com/firehose/latest/dev/create-destination.html). Assurez-vous d'accorder à Firehose l'accès à votre cluster de OpenSearch services, comme décrit dans [Accorder à Kinesis Data Firehose l'accès à une destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-es.html) Amazon ES.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$firehoseClient = new Aws\Firehose\FirehoseClient([
'profile' => 'default',
'version' => '2015-08-04',
'region' => 'us-east-2'
]);
$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,
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Récupérez un flux de diffusion
Pour obtenir des informations sur un flux de diffusion Firehose existant, utilisez l'[DescribeDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DescribeDeliveryStream.html)opération.
**Importations**
```
require 'vendor/autoload.php';
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";
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 à Kinesis Data Streams
Pour répertorier tous les flux de diffusion Firehose existants qui envoient des données à Kinesis Data Streams, utilisez l'opération. [ListDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html)
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$firehoseClient = new Aws\Firehose\FirehoseClient([
'profile' => 'default',
'version' => '2015-08-04',
'region' => 'us-east-2'
]);
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 existants envoyant des données à d'autres AWS services
Pour répertorier tous les flux de diffusion Firehose existants qui envoient des données à Amazon S3, OpenSearch Service, Amazon Redshift ou à Splunk, utilisez l'opération. [ListDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html)
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$firehoseClient = new Aws\Firehose\FirehoseClient([
'profile' => 'default',
'version' => '2015-08-04',
'region' => 'us-east-2'
]);
try {
$result = $firehoseClient->listDeliveryStreams([
'DeliveryStreamType' => 'DirectPut',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Envoyer des données vers un flux de diffusion Firehose existant
Pour envoyer des données via un flux de diffusion Firehose vers la destination que vous avez spécifiée, utilisez l'[PutRecord](https://docs.aws.amazon.com/firehose/latest/APIReference/API_API_PutRecord.html)opération après avoir créé un flux de diffusion Firehose.
Avant d'envoyer des données à un flux de diffusion Firehose, utilisez-le `DescribeDeliveryStream` pour vérifier si le flux de diffusion est actif.
**Importations**
```
require 'vendor/autoload.php';
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";
$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 Firehose
Pour supprimer un flux de diffusion Firehose, utilisez l'[DeleteDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeleteDeliveryStreams.html)opération. Ceci supprime également toutes les données envoyées dans le flux de diffusion.
**Importations**
```
require 'vendor/autoload.php';
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";
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 la AWS SDK pour PHP version 3
AWS Elemental MediaConvert est un service de transcodage vidéo basé sur des fichiers doté de fonctionnalités adaptées à la diffusion. Vous pouvez l'utiliser pour créer des ressources destinées à la diffusion et à la diffusion video-on-demand (VOD) sur Internet. Pour plus d’informations, consultez le [Guide de l’utilisateur AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/).
L'API PHP pour AWS Elemental MediaConvert est exposée via la classe *`AWS.MediaConvert`*client. Pour plus d'informations, consultez [https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html)la référence de l'API.
## Créez et gérez des tâches de transcodage dans AWS Elemental MediaConvert
Dans cet exemple, vous utilisez la AWS SDK pour PHP version 3 pour appeler AWS Elemental MediaConvert et créer une tâche de transcodage. Avant de commencer, vous devez télécharger la vidéo d'entrée dans le compartiment Amazon S3 que vous avez configuré pour le stockage d'entrée. [Pour obtenir la liste des codecs et conteneurs vidéo d'entrée pris en charge, consultez la section Codecs et conteneurs [d'entrée pris en charge dans le guide de l'utilisateur](https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html).AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/)
Les exemples suivants montrent comment :
+ Créez des tâches de transcodage dans. AWS Elemental MediaConvert[CreateJob](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#createjob).
+ Annulez une tâche de transcodage depuis la AWS Elemental MediaConvert file d'attente. [CancelJob](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#canceljob)
+ Récupérez le JSON pour une tâche de transcodage terminée. [GetJob](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#getjob)
+ Récupérez un tableau JSON contenant jusqu'à 20 des dernières tâches créées. [ListJobs](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#listjobs)
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
### Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour accéder au MediaConvert client, créez un rôle IAM qui donne AWS Elemental MediaConvert accès à vos fichiers d'entrée et aux compartiments Amazon S3 dans lesquels vos fichiers de sortie sont stockés. Pour plus de détails, consultez la section [Configurer les autorisations IAM](https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html) dans le [guide de l'AWS Elemental MediaConvert utilisateur](https://docs.aws.amazon.com/mediaconvert/latest/ug/).
### Création d'un client
Configurez le AWS SDK pour PHP en créant un MediaConvert client, avec la région de votre code. Dans cet exemple, la région est définie sur us-west-2.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\MediaConvert\MediaConvertClient;
```
**Exemple de code**
```
$mediaConvertClient = new MediaConvertClient([
'version' => '2017-08-29',
'region' => 'us-east-2',
'profile' => 'default'
]);
```
### Définition d'une tâche de transcodage simple
Cré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 [AWS Elemental MediaConvert console](https://console.aws.amazon.com/mediaconvert/home) pour générer les paramètres de tâche JSON en choisissant vos paramètres de tâche dans la console, puis en choisissant **Afficher le JSON de la tâche** en bas de la section **Job**. Cet exemple illustre le code 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",
"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" => [
"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éez une tâche
Après avoir créé les paramètres de tâche JSON, appelez la méthode createJob en appelant un objet `AWS.MediaConvert service object` et en transmettant les paramètres. L'ID de la tâche créée est renvoyé 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";
}
```
### Récupérer une offre d'emploi
Avec le JobID renvoyé lorsque vous avez appelé createjob, vous pouvez obtenir des descriptions détaillées des tâches récentes au format JSON.
**Exemple de code**
```
$mediaConvertClient = new MediaConvertClient([
'version' => '2017-08-29',
'region' => 'us-east-2',
'profile' => 'default'
]);
try {
$result = $mediaConvertClient->getJob([
'Id' => 'JOB_ID',
]);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
### Annuler une tâche
Avec le JobID renvoyé lorsque vous avez appelé createjob, vous pouvez annuler une tâche pendant qu'elle est encore dans la file d'attente. Vous ne pouvez pas annuler des tâches qui ont déjà commencé le transcodage.
**Exemple de code**
```
$mediaConvertClient = new MediaConvertClient([
'version' => '2017-08-29',
'region' => 'us-east-2',
'profile' => 'default'
]);
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";
}
```
### Liste des travaux de transcodage récents
Créez le code JSON des paramètres, y compris les valeurs pour spécifier si vous souhaitez trier la liste dans l'ordre ASCENDING (croissant) ou DESCENDING (décroissant), l'ARN de la file d'attente de tâches à vérifier et le statut des tâches à inclure. Cela renvoie jusqu'à 20 tâches. Pour récupérer les 20 tâches les plus récentes suivantes, utilisez la chaîne nextToken renvoyée avec le résultat.
**Exemple de code**
```
$mediaConvertClient = new MediaConvertClient([
'version' => '2017-08-29',
'region' => 'us-east-2',
'profile' => 'default'
]);
try {
$result = $mediaConvertClient->listJobs([
'MaxResults' => 20,
'Order' => 'ASCENDING',
'Queue' => 'QUEUE_ARN',
'Status' => 'SUBMITTED',
// 'NextToken' => '', //OPTIONAL To retrieve the twenty next most recent jobs
]);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
# Exemples d'Amazon S3 utilisant la AWS SDK pour PHP version 3
Amazon Simple Storage Service (Amazon S3) est un service Web qui fournit un stockage dans le cloud hautement évolutif. Amazon S3 fournit un stockage d'objets facile à utiliser, avec une interface de service Web simple permettant de stocker et de récupérer n'importe quel volume de données, où que vous soyez sur le Web.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
**Topics**
+ [Informations d’identification](#examplecredentials)
+ [Création et utilisation de compartiments Amazon S3](s3-examples-creating-buckets.md)
+ [Gestion des autorisations d'accès au compartiment Amazon S3](s3-examples-access-permissions.md)
+ [Configuration des compartiments Amazon S3](s3-examples-configuring-a-bucket.md)
+ [Téléchargements partitionnés sur Amazon S3](s3-multipart-upload.md)
+ [URL pré-signée Amazon S3](s3-presigned-url.md)
+ [Création de S3 pré-signé POSTs](s3-presigned-post.md)
+ [Utilisation d'un compartiment Amazon S3 en tant qu'hôte Web statique](s3-examples-static-web-host.md)
+ [Utilisation des politiques relatives aux compartiments Amazon S3](s3-examples-bucket-policies.md)
+ [Utilisation du point d'accès S3 ARNs](s3-examples-access-point-arn.md)
+ [Utiliser des points d'accès multirégionaux](s3-multi-region-access-points.md)
# Création et utilisation de compartiments Amazon S3 avec la AWS SDK pour PHP version 3
Les exemples suivants montrent comment :
+ Renvoie une liste des buckets appartenant à l'expéditeur authentifié de la demande en utilisant. [ListBuckets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#listbuckets)
+ Créez un nouveau compartiment à l'aide de [CreateBucket](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#createbucket).
+ Ajoutez un objet à un compartiment à l'aide de [PutObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
**Importations**
```
require 'vendor/autoload.php';
use Aws\S3\S3Client;
```
## Lister les compartiments
Créez un fichier PHP avec le code suivant. Créez d'abord un service client AWS.S3 qui spécifie la AWS région et la version. Appelez ensuite la `listBuckets` méthode, qui renvoie tous les compartiments Amazon S3 appartenant à l'expéditeur de la demande sous la forme d'un tableau de structures de compartiments.
**Exemple de code**
```
$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éation d’un compartiment
Créez un fichier PHP avec le code suivant. Créez d'abord un service client AWS.S3 qui spécifie la AWS région et la version. Appelez ensuite la méthode `createBucket` avec un tableau comme paramètre. Le seul champ obligatoire est le compartiment (« Bucket ») clé, avec une valeur de chaîne pour le nom du compartiment à créer. Cependant, vous pouvez spécifier la AWS région à l'aide du champ CreateBucketConfiguration « ». Si elle aboutit, cette méthode renvoie l'emplacement (« Location ») du compartiment.
**Exemple de code**
```
function createBucket($s3Client, $bucketName)
{
try {
$result = $s3Client->createBucket([
'Bucket' => $bucketName,
]);
return 'The bucket\'s location is: ' .
$result['Location'] . '. ' .
'The bucket\'s effective URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e->getAwsErrorMessage();
}
}
function createTheBucket()
{
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2006-03-01'
]);
echo createBucket($s3Client, 'amzn-s3-demo-bucket');
}
// Uncomment the following line to run this code in an AWS account.
// createTheBucket();
```
## Placer un objet dans un seau
Pour 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 lequel vous 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 \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 au compartiment Amazon S3 avec la AWS SDK pour PHP version 3
Les listes de contrôle d'accès (ACLs) sont l'une des options de politique d'accès basées sur les ressources que vous pouvez utiliser pour gérer l'accès à vos compartiments et objets. Vous pouvez l'utiliser ACLs pour accorder read/write des autorisations de base à d'autres AWS comptes. Pour en savoir plus, consultez [la section Gestion de l'accès avec ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
L’exemple suivant indique comment :
+ Obtenez la politique de contrôle d'accès pour un bucket à l'aide de [GetBucketAcl](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketacl).
+ Définissez les autorisations sur un bucket en utilisant ACLs, en utilisant [PutBucketAcl](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketacl).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Obtenir et définir une politique de liste de contrôle d'accès
**Importations**
```
require 'vendor/autoload.php';
use Aws\S3\S3Client;
use Aws\Exception\AwsException;
```
**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 = 'amzn-s3-demo-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' => '',
'EmailAddress' => '',
'ID' => '',
'Type' => 'CanonicalUser',
'URI' => '',
],
'Permission' => 'FULL_CONTROL',
],
// ...
],
'Owner' => [
'DisplayName' => '',
'ID' => '',
],
],
'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 des compartiments Amazon S3 avec la AWS SDK pour PHP version 3
Le partage des ressources cross-origin (CORS) définit un moyen pour les applications Web clientes chargées dans un domaine particulier d’interagir avec les ressources d’un autre domaine. Grâce à la prise en charge du CORS dans Amazon S3, vous pouvez créer des applications Web riches côté client avec Amazon S3 et autoriser de manière sélective un accès inter-origines à vos ressources Amazon S3.
Pour plus d'informations sur l'utilisation de la configuration CORS avec un compartiment Amazon S3, consultez [Cross-Origin Resource Sharing (CORS](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html)).
Les exemples suivants montrent comment :
+ Obtenez la configuration CORS d'un bucket à l'aide [GetBucketCors](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketcors)de.
+ Définissez la configuration CORS pour un bucket à l'aide [PutBucketCors](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketcors)de.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Obtenez la configuration CORS
Créez un fichier PHP avec le code suivant. Commencez par créer un service client AWS.S3, puis appelez la méthode `getBucketCors` et spécifiez le compartiment dont vous souhaitez définir la configuration CORS.
Le seul paramètre obligatoire est le nom du compartiment sélectionné. Si le compartiment possède actuellement une configuration CORS, cette configuration est renvoyée par Amazon S3 sous forme d'[CORSRules objet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#shape-corsrule).
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**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éfinissez la configuration CORS
Créez un fichier PHP avec le code suivant. Commencez par créer un service client AWS.S3. Appelez ensuite la `putBucketCors` méthode et spécifiez le bucket dont vous souhaitez définir la configuration CORS, puis CORSConfiguration sous forme d'[objet CORSRules JSON](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#shape-corsrule).
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**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
],
],
]
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# Utilisation des téléchargements partitionnés sur Amazon S3 avec AWS SDK pour PHP la version 3
Vous pouvez charger des objets de taille inférieure ou égale à 5 Go à l'aide d'une simple opé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.
L’exemple suivant indique comment :
+ Chargez un objet sur Amazon S3 à l'aide de [ObjectUploader](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.ObjectUploader.html).
+ Créez un téléchargement partitionné pour un objet Amazon S3 à l'aide [MultipartUploader](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.MultipartUploader.html)de.
+ Copiez des objets d'un emplacement Amazon S3 à un autre en utilisant [ObjectCopier](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.ObjectCopier.html).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Uploader des objets
Si vous n'êtes pas sûr de la solution la mieux adaptée à la tâche, utilisez`ObjectUploader`. `PutObject` `MultipartUploader` `ObjectUploader`télécharge un fichier volumineux sur Amazon S3 en utilisant l'un ou l'autre `PutObject` ou `MultipartUploader` en fonction de la taille de la charge utile.
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\ObjectUploader;
use Aws\S3\S3Client;
```
**Exemple de code**
```
// Create an S3Client.
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-east-2',
'version' => '2006-03-01'
]);
$bucket = 'your-bucket';
$key = 'my-file.zip';
// Use a stream instead of a 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('File successfully uploaded to ' . $result["ObjectURL"] . '.
');
}
print($result);
// If the SDK chooses a multipart upload, try again if there is an exception.
// Unlike PutObject calls, multipart upload calls are not automatically retried.
} catch (MultipartUploadException $e) {
rewind($source);
$uploader = new MultipartUploader($s3Client, $source, [
'state' => $e->getState(),
]);
}
} while (!isset($result));
fclose($source);
```
### Configuration
Le constructeur de l'objet `ObjectUploader` accepte les arguments suivants :
**`$client`**
L'objet `Aws\ClientInterface` à utiliser pour effectuer les transferts. Il doit s'agir d'une instance de `Aws\S3\S3Client`.
**`$bucket`**
(`string`, *obligatoire*) Nom du compartiment vers lequel l’objet est chargé.
**`$key`**
(`string`, *obligatoire*) Clé à utiliser pour l’objet concerné par le chargement.
**`$body`**
(`mixed`, *obligatoire*) Données d'objet à télécharger. Il peut s'agir `StreamInterface` d'une ressource de flux PHP ou d'une chaîne de données à télécharger.
**`$acl`**
(`string`) Liste de contrôle d'accès (ACL) à définir sur l'objet concerné par le chargement. Les objets sont privés par défaut.
**`$options`**
Un tableau associatif d'options de configuration pour le chargement partitionné. Les options de configuration suivantes sont valides :
**`add_content_md5`**
(`bool`) Réglez sur true pour calculer automatiquement la MD5 somme de contrôle pour le téléchargement.
**`mup_threshold`**
(`int`, *par défaut* :`int(16777216)`) Le nombre d'octets correspondant à la taille du fichier. Si la taille du fichier dépasse cette limite, un téléchargement partitionné est utilisé.
**`before_complete`**
(`callable`) Rappel à invoquer avant l'opération `CompleteMultipartUpload`. Le rappel doit avoir une signature de fonction similaire à :`function (Aws\Command $command) {...}`. Consultez la [référence de l'CompleteMultipartUpload API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#completemultipartupload) pour connaître les paramètres que vous pouvez ajouter à l'`CommandInterface`objet.
**`before_initiate`**
(`callable`) Rappel à invoquer avant l'opération `CreateMultipartUpload`. Le rappel doit avoir une signature de fonction similaire à :`function (Aws\Command $command) {...}`. Le SDK invoque ce rappel si la taille du fichier dépasse la valeur. `mup_threshold` Consultez la [référence de l'CreateMultipartUpload API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#createmultipartupload) pour connaître les paramètres que vous pouvez ajouter à l'`CommandInterface`objet.
**`before_upload`**
(`callable`) Rappel à invoquer avant `PutObject` toute `UploadPart` opération. Le rappel doit avoir une signature de fonction similaire à :`function (Aws\Command $command) {...}`. Le SDK invoque ce rappel si la taille du fichier est inférieure ou égale à la valeur. `mup_threshold` Consultez la [référence de l'PutObject API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject) pour connaître les paramètres que vous pouvez appliquer à la `PutObject` demande. Pour les paramètres qui s'appliquent à une `UploadPart` demande, consultez la [référence de l'UploadPart API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#uploadpart). Le SDK ignore tout paramètre non applicable à l'opération représentée par l'`CommandInterface`objet.
**`concurrency`**
(`int`, *par défaut* : `int(3)`) Nombre maximal d’opérations `UploadPart` simultanées autorisées pendant le chargement partitionné.
**`part_size`**
(`int`, *par défaut* : `int(5242880)`) Taille de partie, en octets, à utiliser lors d’un chargement partitionné. La valeur 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 `$key` arguments `$bucket` et et l'`part_size`option sont ignorés.
**`params`**
Tableau associatif qui fournit des options de configuration pour chaque sous-commande. Par exemple :
```
new ObjectUploader($bucket, $key, $body, $acl, ['params' => ['CacheControl' => ])
```
## MultipartUploader
Les chargements partitionnés sont conçus pour améliorer l'expérience de chargement pour les objets volumineux. Ils vous permettent de charger des parties d'objets indépendamment, dans n'importe quel ordre, et en parallèle.
Les clients Amazon S3 sont invités à utiliser les téléchargements partitionnés pour les objets de plus de 100 Mo.
## MultipartUploader objet
Le kit SDK dispose d'un objet `MultipartUploader` spécial qui simplifie le processus de chargement partitionné.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Exemple de code**
```
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
// Use multipart upload
$source = '/path/to/large/file.zip';
$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 configuration fournies, et tente de charger toutes les parties. Si le chargement de certaines parties échoue, le chargeur continue 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 des informations sur ces dernières.
## Personnalisation d'un téléchargement en plusieurs parties
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é via des rappels transmis à son constructeur.
**Importations**
```
require 'vendor/autoload.php';
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**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 (Command $command) {
// $command is a CreateMultipartUpload operation
$command['CacheControl'] = 'max-age=3600';
},
'before_upload' => function (Command $command) {
// $command is an UploadPart operation
$command['RequestPayer'] = 'requester';
},
'before_complete' => function (Command $command) {
// $command is a CompleteMultipartUpload operation
$command['RequestPayer'] = 'requester';
},
]);
```
### Collecte manuelle des déchets entre les chargements partiels
Si vous atteignez la limite de mémoire lors de chargements volumineux, c'est peut-être parce que des références cycliques générées par le kit SDK n'ont pas encore été traitées par le [nettoyage de mémoire de PHP](https://www.php.net/manual/en/features.gc.php). L'appel manuel de l'algorithme de nettoyage entre les opérations peut permettre le traitement des cycles avant que cette limite ne soit atteinte. L'exemple suivant appelle l'algorithme de nettoyage en utilisant un rappel avant le chargement de chaque partie. Notez que l'appel du nettoyage de mémoire représente un coût en termes de performances, et que l'utilisation optimale dépendra de votre cas d'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 des erreurs
Lorsqu'une erreur se produit au cours du processus de chargement partitionné, une exception `MultipartUploadException` est levée. Cette exception donne accès à l'objet `UploadState`, qui contient des informations sur la progression du chargement partitionné. L'objet `UploadState` peut être utilisé pour reprendre un chargement qui n'a pas pu aboutir.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Exemple de code**
```
// Create an S3Client
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
$source = '/path/to/large/file.zip';
$uploader = new MultipartUploader($s3Client, $source, [
'bucket' => 'your-bucket',
'key' => 'my-file.zip',
]);
//Recover from errors
do {
try {
$result = $uploader->upload();
} catch (MultipartUploadException $e) {
$uploader = new MultipartUploader($s3Client, $source, [
'state' => $e->getState(),
]);
}
} while (!isset($result));
//Abort a multipart upload if failed
try {
$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 qui n'ont pas encore été chargées. L'objet d'état assure le suivi des parties manquantes, même si elles ne se suivent pas. Le chargeur lit ou recherche dans le fichier source fourni les plages d'octets appartenant aux parties qui n'ont pas encore été chargées.
Les objets `UploadState` étant sérialisables, vous pouvez également reprendre un chargement dans un processus 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 automatiquement rembobinés avant le chargement. Si vous utilisez un flux à la place d'un chemin d'accès dans une boucle similaire à celle de l'exemple précédent, réinitialisez la variable `$source` à l'intérieur du bloc `catch`.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Exemple de code**
```
// Create an S3Client
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
//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));
fclose($source);
```
### Interruption d’un chargement partitionné
Un chargement partitionné peut être interrompu en récupérant le `UploadId` contenu dans l'objet `UploadState` 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 asynchrones
Appeler `upload()` sur le `MultipartUploader` constitue une demande de blocage. Si vous travaillez dans un contexte asynchrone, vous pouvez obtenir une [promesse](guide_promises.md) pour le chargement partitionné.
```
require 'vendor/autoload.php';
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Exemple de code**
```
// Create an S3Client
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
$source = '/path/to/large/file.zip';
$uploader = new MultipartUploader($s3Client, $source, [
'bucket' => 'your-bucket',
'key' => 'my-file.zip',
]);
$promise = $uploader->promise();
```
### Configuration
Le 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 de `Aws\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](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 :
** `acl` **
(`string`) Liste de contrôle d'accès (ACL) à définir sur l'objet concerné par le chargement. Les objets sont privés par défaut.
** `before_complete` **
(`callable`) Rappel à invoquer avant l'opération `CompleteMultipartUpload`. Les rappels doivent avoir une signature de fonction telle que `function (Aws\Command $command) {...}`.
** `before_initiate` **
(`callable`) Rappel à invoquer avant l'opération `CreateMultipartUpload`. Les rappels doivent avoir une signature de fonction telle que `function (Aws\Command $command) {...}`.
** `before_upload` **
(`callable`) Rappel à invoquer avant toute opération `UploadPart`. Les rappels doivent avoir une signature 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ées pendant 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 chargement partitionné. 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.
**`add_content_md5`**
(`boolean`) Réglez sur true pour calculer automatiquement la MD5 somme de contrôle pour le téléchargement.
**`params`**
Tableau associatif qui fournit des options de configuration pour chaque sous-commande. Par exemple :
```
new MultipartUploader($client, $source, ['params' => ['CacheControl' => ]])
```
## Copies en plusieurs parties
AWS SDK pour PHP Il inclut également un `MultipartCopy` objet qui est utilisé de la même manière que le`MultipartUploader`, mais qui est conçu pour copier des objets d'une taille comprise entre 5 Go et 5 To dans Amazon S3.
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartCopy;
use Aws\S3\S3Client;
```
**Exemple de code**
```
// Create an S3Client
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
//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";
}
```
# URL pré-signée Amazon S3 avec AWS SDK pour PHP version 3
Vous pouvez authentifier certains types de demandes en transférant les informations requises en tant que paramètres de la chaîne de requête au lieu d'utiliser l'en-tête HTTP Authorization. Cela est utile pour permettre à un navigateur tiers d'accéder directement à vos données privées Amazon S3 par un navigateur tiers, sans transmettre la demande par proxy. L'idée est de créer une demande « pré-signée » et de l'encoder sous forme d'URL utilisable par un autre utilisateur. De plus, vous pouvez limiter une demande pré-signée en spécifiant un délai d'expiration.
## Création d'une URL pré-signée pour une requête HTTP GET
L'exemple de code suivant montre comment créer une URL pré-signée pour une requête HTTP GET à l'aide du SDK pour PHP.
```
'us-west-2',
]);
// Supply a CommandInterface object and an expires parameter to the `createPresignedRequest` method.
$request = $s3Client->createPresignedRequest(
$s3Client->getCommand('GetObject', [
'Bucket' => 'amzn-s3-demo-bucket',
'Key' => 'demo-key',
]),
'+1 hour'
);
// From the resulting RequestInterface object, you can get the URL.
$presignedUrl = (string) $request->getUri();
echo $presignedUrl;
```
La [référence d'API pour la `createPresignedRequest`](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.S3Client.html#method_createPresignedRequest) méthode fournit plus de détails.
Quelqu'un d'autre peut utiliser la `$presignedUrl` valeur pour récupérer l'objet dans l'heure qui suit. Lorsque la requête HTTP GET est effectuée, par exemple à l'aide d'un navigateur, le service S3 voit que l'appel provient de l'utilisateur qui a créé l'URL signée au préalable.
## Création d'une URL pré-signée pour une requête HTTP PUT
L'exemple de code suivant montre comment créer une URL pré-signée pour une requête HTTP PUT à l'aide du SDK pour PHP.
```
'us-west-2',
]);
$request = $s3Client->createPresignedRequest(
$s3Client->getCommand('PutObject', [
'Bucket' => 'amzn-s3-demo-bucket',
'Key' => 'demo-key',
]),
'+1 hour'
);
// From the resulting RequestInterface object, you can get the URL.
$presignedUrl = (string) $request->getUri();
```
Une autre personne peut désormais utiliser l'URL pré-signée dans une requête HTTP PUT pour télécharger un fichier :
```
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
// ...
function uploadWithPresignedUrl($presignedUrl, $filePath, $s3Client): ?Response
{
// Get the HTTP handler from the S3 client.
$handler = $s3Client->getHandlerList()->resolve();
// Create a stream from the file.
$fileStream = new Stream(fopen($filePath, 'r'));
// Create the request.
$request = new Request(
'PUT',
$presignedUrl,
[
'Content-Type' => mime_content_type($filePath),
'Content-Length' => filesize($filePath)
],
$fileStream
);
// Send the request using the handler.
try {
$promise = $handler($request, []);
$response = $promise->wait();
return $response;
} catch (Exception $e) {
echo "Error uploading file: " . $e->getMessage() . "\n";
return null;
}
}
```
# Amazon S3 pré-signé POSTs avec la AWS SDK pour PHP version 3
Tout comme le pré-signé URLs, le pré-signé vous POSTs permet de donner un accès d'écriture à un utilisateur sans lui donner AWS d'informations d'identification. Les formulaires POST pré-signés peuvent être créés à l'aide d'une instance d'[AWSs3 V4. PostObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.PostObjectV4.html)
Les exemples suivants montrent comment :
+ Obtenez des données pour un formulaire de téléchargement POST d'un objet S3 à l'aide de la version [PostObjectV4](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.PostObjectV4.html).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
**Note**
`PostObjectV4`ne fonctionne pas avec les informations d'identification provenant de AWS IAM Identity Center.
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Création de la PostObject V4
Pour 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
+ ensemble de conditions de politique (voir [Construction des politiques](https://docs.aws.amazon.com/AmazonS3/latest/dev/HTTPPOSTForms.html) dans le guide de l'utilisateur d'Amazon Simple Storage Service)
+ Délai d'expiration de la chaîne pour la stratégie (facultatif, une heure par défaut).
**Importations**
```
require '../vendor/autoload.php';
use Aws\S3\PostObjectV4;
use Aws\S3\S3Client;
```
**Exemple de code**
```
require '../vendor/autoload.php';
use Aws\S3\PostObjectV4;
use Aws\S3\S3Client;
$client = new S3Client([
'profile' => 'default',
'region' => 'us-east-1',
]);
$bucket = 'amzn-s3-demo-bucket10';
$starts_with = 'user/eric/';
$client->listBuckets();
// Set 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', $starts_with],
];
// Set an expiration time (optional).
$expires = '+2 hours';
$postObject = new PostObjectV4(
$client,
$bucket,
$formInputs,
$options,
$expires
);
// Get attributes for the HTML form, for example, action, method, enctype.
$formAttributes = $postObject->getFormAttributes();
// Get attributes for the HTML form values.
$formInputs = $postObject->getFormInputs();
?>
PHP
```
# Utilisation d'un compartiment Amazon S3 en tant qu'hôte Web statique avec AWS SDK pour PHP la version 3
Vous pouvez héberger un site web statique sur Amazon S3. Pour en savoir plus, consultez [Hébergement d'un site Web statique sur Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
L’exemple suivant indique comment :
+ Obtenez la configuration du site Web pour un bucket à l'aide de [GetBucketWebsite](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketwebsite).
+ Définissez la configuration du site Web pour un bucket à l'aide de [PutBucketWebsite](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketwebsite).
+ Supprimez la configuration du site Web d'un compartiment à l'aide de [DeleteBucketWebsite](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#deletebucketwebsite).
Tous les exemples de code pour la AWS SDK pour PHP version 3 sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification. Voir [Informations d'identification pour la AWS SDK pour PHP version 3](guide_credentials.md).
## Obtenir, définir et supprimer la configuration du site Web pour un bucket
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**Exemple de code**
```
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
// Retrieving the Bucket Website Configuration
$bucket = 'amzn-s3-demo-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 Configuration
try {
$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 des politiques relatives aux compartiments Amazon S3 avec la AWS SDK pour PHP version 3
Vous pouvez utiliser une politique de compartiment pour accorder des autorisations à vos ressources Amazon S3. Pour en savoir plus, consultez [Utilisation de stratégies de compartiment et de stratégies utilisateur](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
L’exemple suivant indique comment :
+ Renvoie la politique pour un compartiment spécifié à l'aide de [GetBucketPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketpolicy).
+ Remplacez une politique sur un bucket à l'aide de [PutBucketPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketpolicy).
+ Supprimez une politique d'un bucket à l'aide de [DeleteBucketPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#deletebucketpolicy).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Obtenir, supprimer et remplacer une politique sur un bucket
**Importations**
```
require "vendor/autoload.php";
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**Exemple de code**
```
$s3Client = new S3Client([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2006-03-01'
]);
$bucket = 'amzn-s3-demo-bucket';
// Get the policy of a specific bucket
try {
$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 bucket
try {
$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";
}
// Replaces a policy on the bucket
try {
$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";
}
```
# Utilisation du point ARNs d'accès S3 ( AWS SDK pour PHP version 3)
S3 a introduit des points d'accès, une nouvelle façon d'interagir avec les compartiments S3. Les points d'accès peuvent avoir des stratégies et une configuration uniques appliquées à eux plutôt que directement au compartiment. Vous AWS SDK pour PHP permet d'utiliser le point d'accès ARNs dans le champ du bucket pour les opérations d'API au lieu de spécifier explicitement le nom du bucket. Vous trouverez plus de détails sur le fonctionnement et le ARNs fonctionnement des points d'accès S3 [ici](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html). Les exemples suivants montrent comment :
+ [GetObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getobject)À utiliser avec l'ARN d'un point d'accès pour récupérer un objet depuis un bucket.
+ [PutObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject)À utiliser avec l'ARN d'un point d'accès pour ajouter un objet à un bucket.
+ Configurez le client S3 pour qu'il utilise la région ARN au lieu de la région client.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
**Importations**
```
require 'vendor/autoload.php';
use Aws\S3\S3Client;
```
## Obtenir un objet
Créez d'abord un service client AWS.S3 qui spécifie la AWS région et la version. Ensuite, appelez la méthode `getObject` avec votre clé et un ARN de point d'accès S3 dans le champ `Bucket`, qui récupère l'objet du compartiment associé à ce point d'accès.
**Exemple de code**
```
$s3 = new S3Client([
'version' => 'latest',
'region' => 'us-west-2',
]);
$result = $s3->getObject([
'Bucket' => 'arn:aws:s3:us-west-2:123456789012:accesspoint:endpoint-name',
'Key' => 'MyKey'
]);
```
## Placer un objet dans un seau
Créez d'abord un service client AWS.S3 qui spécifie la AWS région et la version. Ensuite, appelez la méthode `putObject` avec la clé, le corps ou le fichier source souhaité(e), et un ARN de point d'accès S3 dans le champ `Bucket`, ce qui placera l'objet dans le compartiment associé à ce point d'accès.
**Exemple de code**
```
$s3 = new S3Client([
'version' => 'latest',
'region' => 'us-west-2',
]);
$result = $s3->putObject([
'Bucket' => 'arn:aws:s3:us-west-2:123456789012:accesspoint:endpoint-name',
'Key' => 'MyKey',
'Body' => 'MyBody'
]);
```
## Configurer le client S3 pour qu'il utilise la région ARN au lieu de la région cliente
Lors de l'utilisation d'un ARN de point d'accès S3 dans une opération cliente S3, par défaut, le client s'assure que la région ARN correspond à la région cliente, en lançant une exception si ce n'est pas le cas. Ce comportement peut être modifié pour accepter la région ARN sur la région client en définissant l'option de configuration `use_arn_region` sur `true`. Par défaut, l'option est définie sur `false`.
**Exemple de code**
```
$s3 = new S3Client([
'version' => 'latest',
'region' => 'us-west-2',
'use_arn_region' => true
]);
```
Le client vérifiera également une variable d'environnement et une option de fichier de configuration, dans l'ordre de priorité suivant :
1. L'option client `use_arn_region`, comme dans l'exemple ci-dessus.
1. La variable d'environnement `AWS_S3_USE_ARN_REGION`
```
export AWS_S3_USE_ARN_REGION=true
```
1. La variable de configuration `s3_use_arn_region` dans le fichier de configuration AWS partagé (par défaut dans`~/.aws/config`).
```
[default]
s3_use_arn_region = true
```
# Utilisez les points d'accès multirégionaux Amazon S3 avec la AWS SDK pour PHP version 3
Les points d'[accès multirégionaux Amazon Simple Storage Service (S3)](https://docs.aws.amazon.com//AmazonS3/latest/userguide/MultiRegionAccessPoints.html) fournissent un point de terminaison global pour acheminer le trafic de demandes Amazon S3 entre les deux. Régions AWS
Vous pouvez créer des points d'accès multirégionaux à [l'aide du SDK pour](https://docs.aws.amazon.com//aws-sdk-php/v3/api/api-s3control-2018-08-20.html#createmultiregionaccesspoint) PHP, d' AWS un autre SDK, de la console [S3 ou de la CLI, AWS](https://docs.aws.amazon.com//AmazonS3/latest/userguide/multi-region-access-point-create-examples.html)
**Important**
Pour utiliser des points d'accès multirégionaux avec le SDK pour PHP, l'extension [Common Runtime AWS (CRT) doit être installée AWS dans](guide_crt.md) votre environnement PHP.
Lorsque vous créez un point d'accès multirégional, Amazon S3 génère un Amazon Resource Name (ARN) au format suivant :
`arn:aws:s3::account-id:accesspoint/MultiRegionAccessPoint_alias`
Vous pouvez utiliser l'ARN généré à la place du nom du bucket pour `[getObject()](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getobject)` et `[putObject()](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject)` des méthodes.
```
'us-east-1'
]);
$s3Client->putObject([
'Bucket' => $mrap,
'Key' => $key,
'Body' => 'Hello World!'
]);
$result = $s3Client->getObject([
'Bucket' => $mrap,
'Key' => $key
]);
echo $result['Body'] . "\n";
// Clean up.
$result = $s3Client->deleteObject([
'Bucket' => $mrap,
'Key' => $key
]);
$s3Client->waitUntil('ObjectNotExists', ['Bucket' => $mrap, 'Key' => $key]);
echo "Object deleted\n";
```
# Gestion des secrets à l'aide de l'API Secrets Manager et de la AWS SDK pour 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 et les informations d'identification de base de données. Avec le service Secrets Manager, les développeurs peuvent remplacer les informations d'identification codées en dur dans le code déployé par un appel intégré à Secrets Manager.
Secrets Manager prend en charge de manière native la rotation planifiée automatique des informations d'identification pour les bases de données Amazon Relational Database Service (Amazon RDS), renforçant ainsi la sécurité des applications. Secrets Manager peut également effectuer une rotation fluide des secrets pour d'autres bases de données et services tiers AWS Lambda afin d'implémenter des détails spécifiques aux services.
Les exemples suivants montrent comment :
+ Créez un secret à l'aide de [CreateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#createsecret).
+ Récupérez un secret en utilisant [GetSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#getsecretvalue).
+ Répertoriez tous les secrets stockés par Secrets Manager à l'aide de [ListSecrets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#listsecrets).
+ Obtenez des informations sur un secret spécifié à l'aide de [DescribeSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#describesecret).
+ Mettez à jour un secret spécifié à l'aide de [PutSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#putsecretvalue).
+ Configurez une rotation secrète à l'aide de [RotateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret).
+ Marquez un secret pour la suppression à l'aide de [DeleteSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#deletesecret).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Création d'un secret dans Secrets Manager
Pour créer un secret dans Secrets Manager, utilisez l'[CreateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#createsecret)opération.
Dans cet exemple, un nom d'utilisateur et un mot de passe sont stockés sous forme de chaîne JSON.
**Importations**
```
require 'vendor/autoload.php';
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 = json_encode([
"username" => getenv("SMDEMO_USERNAME"),
"password" => getenv("SMDEMO_PASSWORD"),
]);
$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érez un secret depuis Secrets Manager
Pour récupérer la valeur d'un secret stocké dans Secrets Manager, utilisez l'[GetSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#getsecretvalue)opération.
Dans l'exemple suivant, `secret` il s'agit d'une chaîne contenant la valeur stockée. Si la valeur pour `username` est `<>` et la valeur pour `password` est`<>`, le résultat de `secret` est :
```
{"username":"<>","password":"<>"}
```
`json_decode($secret, true)`Utilisez-le pour accéder aux valeurs du tableau.
**Importations**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$client = new SecretsManagerClient([
'profile' => 'default',
'version' => '2017-10-17',
'region' => 'us-east-1',
]);
$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']);
}
print $secret;
$secretArray = json_decode($secret, true);
$username = $secretArray['username'];
$password = $secretArray['password'];
// Your code goes here;
```
## Répertorier les secrets stockés dans Secrets Manager
Obtenez une liste de tous les secrets stockés par Secrets Manager à l'aide de cette [ListSecrets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#listsecrets)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$client = new SecretsManagerClient([
'profile' => 'default',
'version' => '2017-10-17',
'region' => 'us-west-2'
]);
try {
$result = $client->listSecrets([
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Récupérer les détails d'un secret
Les secrets stockés contiennent des métadonnées relatives aux règles de rotation, aux derniers accès ou aux dernières modifications dont ils on fait l'objet, aux balises créées par les utilisateurs, sans oublier l'Amazon Resource Name (ARN). Pour obtenir les détails d'un secret spécifié stocké dans Secrets Manager, utilisez l'[DescribeSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#describesecret)opération.
**Importations**
```
require 'vendor/autoload.php';
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';
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 secret
Pour stocker une nouvelle valeur secrète chiffrée dans Secrets Manager, utilisez l'[PutSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#putsecretvalue)opération.
Cette opération crée une nouvelle version du secret. Si une version du secret existe déjà, ajoutez le paramètre `VersionStages` avec la valeur dans `AWSCURRENT` pour que la nouvelle valeur soit utilisée lors de la récupération de la valeur.
**Importations**
```
require 'vendor/autoload.php';
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 = json_encode([
"username" => getenv("SMDEMO_USERNAME"),
"password" => getenv("SMDEMO_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";
}
```
## Faites pivoter la valeur vers un secret existant dans Secrets Manager
Pour faire pivoter la valeur d'un secret existant stocké dans Secrets Manager, utilisez une fonction de rotation Lambda et l'[RotateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret)opération.
Avant de commencer, créez une fonction Lambda pour faire pivoter votre secret. Le [catalogue d'exemples de AWS code](https://docs.aws.amazon.com/code-samples/latest/catalog/code-catalog-lambda_functions-secretsmanager.html) contient actuellement plusieurs exemples de code Lambda pour la rotation des informations d'identification des bases de données Amazon RDS.
**Note**
Pour plus d'informations sur la rotation des secrets, voir [Rotation de vos AWS Secrets Manager secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) dans le guide de AWS Secrets Manager l'utilisateur.
Après avoir configuré votre fonction Lambda, configurez une nouvelle rotation secrète.
**Importations**
```
require 'vendor/autoload.php';
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';
$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 implémenter une rotation à l'aide de cette [RotateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret)opération.
**Importations**
```
require 'vendor/autoload.php';
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';
try {
$result = $client->rotateSecret([
'SecretId' => $secretName,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Supprimer un secret dans Secrets Manager
Pour supprimer un secret spécifié de Secrets Manager, utilisez l'[DeleteSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#deletesecret)opération. Pour éviter de supprimer accidentellement un secret, un DeletionDate tampon est automatiquement ajouté au secret pour indiquer le délai de restauration pendant lequel vous pouvez annuler la suppression. Si aucune duré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**
```
require 'vendor/autoload.php';
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';
try {
$result = $client->deleteSecret([
'SecretId' => $secretName,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Informations connexes
Les AWS SDK pour PHP exemples utilisent les opérations REST suivantes issues de la référence AWS Secrets Manager d'API :
+ [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html)
+ [GetSecretValue](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html)
+ [ListSecrets](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_ListSecrets.html)
+ [DescribeSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DescribeSecret.html)
+ [PutSecretValue](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_PutSecretValue.html)
+ [RotateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html)
+ [DeleteSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html)
Pour plus d'informations sur l'utilisation AWS Secrets Manager, consultez le [guide de AWS Secrets Manager l'utilisateur](https://docs.aws.amazon.com/secretsmanager/latest/userguide/).
# Exemples d'Amazon SES utilisant la AWS SDK pour PHP version 3
Amazon Simple Email Service (Amazon SES) est une plateforme de messagerie qui vous permet d'envoyer et de recevoir des e-mails de manière simple et économique en utilisant vos propres adresses e-mail et domaines. Pour plus d'informations sur Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
AWS [propose deux versions du service Amazon SES et, par conséquent, le SDK pour PHP propose deux versions du client [SesClient](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Ses.SesClient.html): et SESV2Client.](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.SesV2.SesV2Client.html) Les fonctionnalités des clients se chevauchent dans de nombreux cas, bien que la façon dont les méthodes sont appelées ou les résultats puissent différer. Les deux offrent APIs également des fonctionnalités exclusives, de sorte que vous pouvez utiliser les deux clients pour accéder à toutes les fonctionnalités.
Les exemples de cette section utilisent tous l'original,`SesClient`.
Tous les exemples de code pour la AWS SDK pour PHP version 3 sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Vérification des adresses e-mail](ses-verify.md)
+ [Utilisation de modèles d'e-mail](ses-template.md)
+ [Gestion des filtres de courrier électronique](ses-filters.md)
+ [Utilisation des règles relatives aux e-mails](ses-rules.md)
+ [Surveillez votre activité d'envoi](ses-send-email.md)
+ [Autorisation des expéditeurs](ses-sender-policy.md)
# Vérification de l'identité des e-mails à l'aide de l'API Amazon SES et de la AWS SDK pour PHP version 3
Lorsque vous commencez à utiliser votre compte Amazon Simple Email Service (Amazon SES), tous les expéditeurs et destinataires doivent être vérifiés dans la AWS même région que celle à laquelle vous envoyez des e-mails. Pour plus d’informations sur l’envoi d’e-mails, consultez la section [Envoi d’e-mails avec Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-email.html).
Les exemples suivants montrent comment :
+ Vérifiez une adresse e-mail à l'aide de [VerifyEmailIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifyemailidentity).
+ Vérifiez un domaine de messagerie à l'aide de [VerifyDomainIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifydomainidentity).
+ Répertoriez toutes les adresses e-mail en utilisant [ListIdentities](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities).
+ Répertoriez tous les domaines de messagerie utilisant [ListIdentities](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities).
+ Supprimez une adresse e-mail à l'aide de [DeleteIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity).
+ Supprimez un domaine de messagerie à l'aide de [DeleteIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Vérifier une adresse e-mail
Amazon SES peut envoyer des e-mails uniquement à partir d'adresses e-mail ou de domaines vérifiés. En vérifiant une adresse e-mail, vous démontrez que vous êtes le propriétaire de cette adresse et que vous souhaitez 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 vous avez spécifiée. Lorsque vous (ou le destinataire de l’e-mail) cliquez sur le lien dans l’e-mail, l’adresse est vérifiée.
Pour ajouter une adresse e-mail à votre compte Amazon SES, utilisez l'[VerifyEmailIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyEmailIdentity.html)opération.
**Importations**
```
require 'vendor/autoload.php';
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";
}
```
## Vérifier un domaine de messagerie
Amazon SES peut envoyer des e-mails uniquement à partir d'adresses e-mail ou de domaines vérifiés. En vérifiant un domaine, vous démontrez que vous êtes le propriétaire de ce domaine. Lorsque vous validez un domaine, vous autorisez Amazon SES à envoyer des e-mails depuis n'importe quelle adresse de ce domaine.
Lorsque vous exécutez l'exemple de code suivant, Amazon SES vous fournit un jeton de vérification. Vous devez ajouter le jeton à la configuration DNS de votre domaine. Pour plus d'informations, consultez la section [Vérifier un domaine auprès d'Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html) dans le manuel Amazon Simple Email Service Developer Guide.
Pour ajouter un domaine d'envoi à votre compte Amazon SES, utilisez l'[VerifyDomainIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyDomainIdentity.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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 les adresses e-mail
Pour récupérer une liste d'adresses e-mail soumises dans la AWS région actuelle, quel que soit le statut de vérification, utilisez l'[ListIdentities](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
try {
$result = $SesClient->listIdentities([
'IdentityType' => 'EmailAddress',
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Lister les domaines de messagerie
Pour récupérer une liste de domaines de messagerie soumis dans la AWS région actuelle, quel que soit le statut de vérification, utilisez l'[ListIdentities](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
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-mail
Pour supprimer une adresse e-mail vérifiée de la liste des identités, utilisez l'[DeleteIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html)opération.
**Importations**
```
require 'vendor/autoload.php';
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->deleteIdentity([
'Identity' => $email,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Supprimer un domaine de messagerie
Pour supprimer un domaine de messagerie vérifié de la liste des identités vérifiées, utilisez l'[DeleteIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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";
}
```
# Création de modèles d'e-mails personnalisés à l'aide de l'API Amazon SES et de la AWS SDK pour PHP version 3
Amazon Simple Email Service (Amazon SES) vous permet d'envoyer des e-mails personnalisés pour chaque destinataire à l'aide de modèles. Les modèles incluent une ligne d’objet, ainsi que les parties texte et HTML du corps de l’e-mail. Les sections objet et corps peuvent également contenir des valeurs uniques personnalisées pour chaque destinataire.
Pour plus d'informations, consultez la section [Envoi d'e-mails personnalisés à l'aide d'Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) dans le manuel Amazon Simple Email Service Developer Guide.
Les exemples suivants montrent comment :
+ Créez un modèle d'e-mail à l'aide de [CreateTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createtemplate).
+ Répertoriez tous les modèles d'e-mails en utilisant [ListTemplates](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listtemplates).
+ Récupérez un modèle d'e-mail à l'aide de [GetTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#gettemplate).
+ Mettez à jour un modèle d'e-mail à l'aide de [UpdateTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updateTemplate).
+ Supprimez un modèle d'e-mail à l'aide de [DeleteTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletetemplate).
+ Envoyez un modèle d'e-mail en utilisant [SendTemplatedEmail](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#sendtemplatedemail).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Créer un modèle d'e-mail
Pour créer un modèle pour envoyer des e-mails personnalisés, utilisez l'[CreateTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateTemplate.html)opération. Le modèle peut être utilisé par n'importe quel compte autorisé à envoyer des messages dans la AWS région à laquelle le modèle est ajouté.
**Note**
Amazon SES ne valide pas votre code HTML. Assurez-vous donc qu'il *HtmlPart*est valide avant d'envoyer un e-mail.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$name = 'Template_Name';
$html_body = 'AWS Amazon Simple Email Service Test Email
' .
'This email was sent with ' .
'Amazon SES using the ' .
'AWS SDK for PHP.
';
$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";
}
```
## Obtenez un modèle d'e-mail
Pour afficher le contenu d'un modèle d'e-mail existant, y compris la ligne d'objet, le corps HTML et le texte brut, utilisez l'[GetTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetTemplate.html)opération. Seul TemplateName est requis.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$name = 'Template_Name';
try {
$result = $SesClient->getTemplate([
'TemplateName' => $name,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Répertorier tous les modèles d'e-mails
Pour récupérer la liste de tous les modèles d'e-mail qui vous sont associés Compte AWS dans la AWS région actuelle, utilisez l'[ListTemplates](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListTemplates.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
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-mail
Pour modifier le contenu d'un modèle d'e-mail spécifique, y compris la ligne d'objet, le corps HTML et le texte brut, utilisez l'[UpdateTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdadteTemplate.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$name = 'Template_Name';
$html_body = 'AWS Amazon Simple Email Service Test Email
' .
'This email was sent with ' .
'Amazon SES using the ' .
'AWS SDK for PHP.
';
$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-mail
Pour supprimer un modèle d'e-mail spécifique, utilisez l'[DeleteTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteTemplate.html)opération. Tout ce dont vous avez besoin, c'est du TemplateName.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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";
}
```
## Envoyer un e-mail avec un modèle
Pour utiliser un modèle pour envoyer un e-mail aux destinataires, utilisez l'[SendTemplatedEmail](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$template_name = 'Template_Name';
$sender_email = 'email_address';
$recipient_emails = ['email_address'];
try {
$result = $SesClient->sendTemplatedEmail([
'Destination' => [
'ToAddresses' => $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 Amazon SES et de la AWS SDK pour PHP version 3
Outre l'envoi d'e-mails, vous pouvez également recevoir des e-mails via Amazon Simple Email Service (Amazon SES). Un filtre d’adresses IP vous permet, le cas échéant, de choisir d’accepter ou de rejeter les messages provenant d’une adresse IP ou d’une plage d’adresses IP. Pour plus d’informations, consultez la section [Gestion des filtres d’adresses IP pour la réception d’e-mails via Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html).
Les exemples suivants montrent comment :
+ Créez un filtre de courrier électronique à l'aide de [CreateReceiptFilter](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptfilter).
+ Répertoriez tous les filtres de courrier électronique utilisés [ListReceiptFilters](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptfilters).
+ Supprimez un filtre de courrier électronique à l'aide de [DeleteReceiptFilter](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptfilter).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Création d'un filtre d'e-mail
Pour autoriser ou bloquer les e-mails provenant d'une adresse IP spécifique, utilisez l'[CreateReceiptFilter](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptFilter.html)opération. Indiquez l’adresse IP ou la plage d’adresses et un nom unique pour identifier ce filtre.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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-mail
Pour répertorier les filtres d'adresse IP qui vous sont associés Compte AWS dans la AWS région actuelle, utilisez l'[ListReceiptFilters](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptFilters.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
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-mail
Pour supprimer un filtre existant pour une adresse IP spécifique, utilisez l'[DeleteReceiptFilter](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptFilter.html)opération. 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éception et en créer un nouveau.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$filter_name = 'FilterName';
try {
$result = $SesClient->deleteReceiptFilter([
'FilterName' => $filter_name,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
# Création et gestion de règles de courrier électronique à l'aide de l'API Amazon SES et de la AWS SDK pour PHP version 3
Outre l'envoi d'e-mails, vous pouvez également recevoir des e-mails via Amazon Simple Email Service (Amazon SES). Les règles de réception vous permettent de spécifier ce que fait Amazon SES avec les e-mails qu'il reçoit pour les adresses e-mail ou les domaines que vous possédez. Une règle peut envoyer des e-mails à d'autres AWS services, notamment Amazon S3, Amazon SNS ou. AWS Lambda
Pour plus d'informations, consultez les sections [Gestion des ensembles de règles de réception pour la réception des e-mails Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) et [Gestion des règles de réception pour la réception des e-mails Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html).
Les exemples suivants montrent comment :
+ Créez un ensemble de règles de réception à l'aide de [CreateReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptruleset).
+ Créez une règle de réception à l'aide de [CreateReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptrule).
+ Décrivez un ensemble de règles de réception utilisant [DescribeReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptruleset).
+ Décrivez une règle de réception à l'aide de [DescribeReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptrule).
+ Répertoriez tous les ensembles de règles de réception en utilisant [ListReceiptRuleSets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptrulesets).
+ Mettez à jour une règle de réception à l'aide de [UpdateReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updatereceiptrule).
+ Supprimez une règle de réception à l'aide de [DeleteReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptrule).
+ Supprimez un ensemble de règles de réception à l'aide de [DeleteReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptruleset).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Créer un jeu de règles de réception
Un ensemble de règles de réception renfermer plusieurs règles de réception. Au moins un ensemble de règles de réception doit être associé à votre compte avant de pouvoir créer une règle de réception. Pour créer un ensemble de règles de réception, indiquez un code unique RuleSetName et utilisez l'[CreateReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRuleSet.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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éation d'une règle de réception
Contrôlez vos e-mails entrants en ajoutant une règle de réception à un ensemble de règles de réception existant. Cet exemple vous montre comment créer une règle de réception qui envoie des messages entrants à un compartiment Amazon S3, mais vous pouvez également envoyer des messages à Amazon SNS et. AWS Lambda Pour créer une règle de réception, fournissez une règle et le RuleSetName à l'[CreateReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$rule_name = 'Rule_Name';
$rule_set_name = 'Rule_Set_Name';
$s3_bucket = 'Bucket_Name';
try {
$result = $SesClient->createReceiptRule([
'Rule' => [
'Actions' => [
[
'S3Action' => [
'BucketName' => $s3_bucket,
],
],
],
'Name' => $rule_name,
'ScanEnabled' => true,
'TlsPolicy' => 'Optional',
'Recipients' => ['']
],
'RuleSetName' => $rule_set_name,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Décrire un jeu de règles de réception
Une fois par seconde, renvoie les détails de l’ensemble de règles de réception spécifié. Pour utiliser l'[DescribeReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRuleSet.html)opération, fournissez le RuleSetName.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$name = 'Rule_Set_Name';
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éception
Renvoie les détails d’une règle de réception spécifiée. Pour utiliser l'[DescribeReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRule.html)opération, fournissez le RuleName et RuleSetName.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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éception
Pour répertorier les ensembles de règles de réception qui existent sous votre nom Compte AWS dans la AWS région actuelle, utilisez l'[ListReceiptRuleSets](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptRuleSets.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
try {
$result = $SesClient->listReceiptRuleSets();
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Mettre à jour une règle de réception
Cet exemple montre comment mettre à jour une règle de réception qui envoie des messages entrants à une AWS Lambda fonction, mais vous pouvez également envoyer des messages à Amazon SNS et Amazon S3. Pour utiliser cette [UpdateReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateReceiptRule.html)opération, entrez la nouvelle règle de réception et le RuleSetName.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$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éception
Supprimez un ensemble de règles de réception qui n'est pas actuellement désactivé. Cette opération supprime également toutes les règles de réception qu’il contient. Pour supprimer un ensemble de règles de réception, fournissez le RuleSetName à l'[DeleteReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRuleSet.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$name = 'Rule_Set_Name';
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éception
Pour supprimer une règle de réception spécifiée, fournissez le RuleName et RuleSetName à l'[DeleteReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRule.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Exemple de code**
```
$SesClient = new Aws\Ses\SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-2'
]);
$rule_name = 'Rule_Name';
$rule_set_name = 'Rule_Set_Name';
try {
$result = $SesClient->deleteReceiptRule([
'RuleName' => $rule_name,
'RuleSetName' => $rule_set_name,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
# Surveillance de votre activité d'envoi à l'aide de l'API Amazon SES et de la AWS SDK pour PHP version 3
Amazon Simple Email Service (Amazon SES) fournit des méthodes pour surveiller votre activité d'envoi. Nous vous recommandons d'implémenter ces méthodes afin d'assurer le suivi des métriques importantes, telles que les taux de retours à l'expéditeur, de réclamations et de rejets. Des taux de rebond et de plaintes trop élevés peuvent compromettre votre capacité à envoyer des e-mails via Amazon SES.
Les exemples suivants montrent comment :
+ Vérifiez votre quota d'envoi à l'aide de [GetSendQuota](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendquota).
+ Surveillez votre activité d'envoi à l'aide de [GetSendStatistics](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendstatistics).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Vérifiez votre quota d'envoi
Vous ne pouvez envoyer qu’une certaine quantité de messages sur une période de 24 heures. Pour vérifier le nombre de messages que vous êtes encore autorisé à envoyer, utilisez l'[GetSendQuota](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendQuota.html)opération. Pour plus d’informations, consultez la section [Gestion de vos limites d’envoi Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html).
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Exemple de code**
```
$SesClient = new SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-1'
]);
try {
$result = $SesClient->getSendQuota();
$send_limit = $result["Max24HourSend"];
$sent = $result["SentLast24Hours"];
$available = $send_limit - $sent;
print("You can send " . $available . " more messages in the next 24 hours.
");
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Surveillez votre activité d'envoi
Pour récupérer les statistiques des messages que vous avez envoyés au cours des deux dernières semaines, utilisez cette [GetSendStatistics](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendStatistics.html)opération. Cet exemple renvoie le nombre de tentatives d’envoi, de retours à l’expéditeur, de réclamations et de messages rejetés par tranche de 15 minutes.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**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";
}
```
# Autorisation des expéditeurs à l'aide de l'API Amazon SES et de la version 3 AWS SDK pour PHP
Pour permettre à un autre Compte AWS, à un Gestion des identités et des accès AWS utilisateur ou à un AWS service d'envoyer des e-mails via Amazon Simple Email Service (Amazon SES) en votre nom, vous devez créer une politique d'autorisation d'envoi. Il s’agit d’un document JSON que vous attachez à une identité dont vous êtes propriétaire.
La stratégie mentionne expressément les entités que vous autorisez à effectuer des envois pour cette identité, ainsi que les conditions associées. Tous les expéditeurs, autres que vous et les entités auxquelles vous 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 également contenir 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](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
Les exemples suivants montrent comment :
+ Créez un expéditeur autorisé à l'aide de [PutIdentityPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createidentitypolicy).
+ Récupérez les politiques d'un expéditeur autorisé à l'aide de [GetIdentityPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getidentitypolicies).
+ Répertoriez les expéditeurs autorisés à l'aide de [ListIdentityPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentitypolicies).
+ Révoquer l'autorisation accordée à un expéditeur autorisé à utiliser [DeleteIdentityPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentitypolicy).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
Pour plus d'informations sur l'utilisation d'Amazon SES, consultez le [manuel du développeur Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Création d'un expéditeur autorisé
Pour autoriser une autre Compte AWS personne à envoyer des e-mails en votre nom, utilisez une politique d'identité pour ajouter ou mettre à jour l'autorisation d'envoyer des e-mails à partir de vos adresses e-mail ou domaines vérifiés. Pour créer une politique d'identité, utilisez l'[PutIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_PutIdentityPolicy.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Exemple de code**
```
$SesClient = new SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-1'
]);
$identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com";
$other_aws_account = "0123456789";
$policy = <<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érez les politiques d'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 donné, utilisez l'[GetIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetIdentityPolicy.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Exemple de code**
```
$SesClient = new SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-1'
]);
$identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com";
$policies = ["policyName"];
try {
$result = $SesClient->getIdentityPolicies([
'Identity' => $identity,
'PolicyNames' => $policies,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
echo $e->getMessage();
echo "\n";
}
```
## Répertorier les expéditeurs autorisés
Pour répertorier les politiques d'autorisation d'envoi associées à une identité e-mail ou à une identité de domaine spécifique dans la AWS région actuelle, utilisez l'[ListIdentityPolicies](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentityPolicies.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Exemple de code**
```
$SesClient = new SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-1'
]);
$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 permettant Compte AWS à une autre personne d'envoyer des e-mails avec une identité e-mail ou une identité de domaine en supprimant la politique d'identité associée à l'[DeleteIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentityPolicy.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Exemple de code**
```
$SesClient = new SesClient([
'profile' => 'default',
'version' => '2010-12-01',
'region' => 'us-east-1'
]);
$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 d'Amazon SNS utilisant la version 3 AWS SDK pour PHP
Amazon Simple Notification Service (Amazon SNS) est un service Web qui coordonne et gère la livraison ou l'envoi de messages aux points de terminaison ou aux clients abonnés.
Sur Amazon SNS, il existe deux types de clients : les éditeurs (également appelés producteurs) et les abonnés (également appelés consommateurs). Les éditeurs communiquent de façon asynchrone avec les abonnés en produisant et en envoyant un message à une rubrique, qui est un point d'accès logique et un canal de communication. Les abonnés (serveurs Web, adresses e-mail, files d'attente Amazon SQS, AWS Lambda fonctions) consomment ou reçoivent le message ou la notification via l'un des protocoles pris en charge (Amazon SQS, HTTP/HTTPS URLs e-mail, AWS SMS Lambda) lorsqu'ils sont abonnés au sujet.
Tous les exemples de code pour la AWS SDK pour PHP version 3 sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Gestion des sujets](sns-examples-managing-topics.md)
+ [Gestion des abonnements](sns-examples-subscribing-unsubscribing-topics.md)
+ [Envoyer des SMS à Amazon](sns-examples-sending-sms.md)
# Gestion des sujets dans Amazon SNS avec la version 3 AWS SDK pour PHP
Pour envoyer des notifications à Amazon Simple Queue Service (Amazon SQS) HTTP/HTTPS URLs, par e-mail AWS Lambda ou par e-mail AWS SMS, vous devez d'abord créer une rubrique qui gère la distribution des messages à tous les abonnés de cette rubrique.
En termes de conception du modèle d’observateur, une rubrique correspond à l’objet. Une fois qu’une rubrique est créée, vous ajoutez des abonnés qui reçoivent automatiquement une notification lorsqu’un message est publié dans cette rubrique.
Pour en savoir plus sur l'abonnement à des rubriques, consultez [la section Gestion des abonnements dans Amazon SNS AWS SDK pour PHP avec](sns-examples-subscribing-unsubscribing-topics.md) la version 3.
Les exemples suivants montrent comment :
+ Créez une rubrique pour publier des notifications d'utilisation [CreateTopic](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#createtopic).
+ Renvoie une liste des sujets du demandeur à l'aide [ListTopics](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listtopic)de.
+ Supprimez un sujet et tous ses abonnements à l'aide de [DeleteTopic](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#deletetopic).
+ Renvoie toutes les propriétés d'une rubrique en utilisant [GetTopicAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#gettopicattributes).
+ Autoriser le propriétaire d'une rubrique à attribuer une nouvelle valeur à un attribut de la rubrique en utilisant [SetTopicAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#settopicattributes).
Pour plus d'informations sur l'utilisation d'Amazon SNS, consultez la [rubrique Attributs d'Amazon SNS relatifs à l'état de livraison des](https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html) messages.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Créer une rubrique
Pour créer un sujet, utilisez l'[CreateTopic](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html)opération.
Chaque nom de rubrique que vous Compte AWS trouverez doit être unique.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$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());
}
```
## Listez vos sujets
Pour répertorier jusqu'à 100 sujets existants dans la AWS région actuelle, utilisez l'[ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
try {
$result = $SnSclient->listTopics();
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Supprimer une rubrique
Pour supprimer un sujet existant et tous ses abonnements, utilisez l'[DeleteTopic](https://docs.aws.amazon.com/sns/latest/api/API_DeleteTopic.html)opération.
Les messages qui n’ont pas encore été livrés aux abonnés seront également supprimés.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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 des rubriques
Pour récupérer les propriétés d'une seule rubrique existante, utilisez l'[GetTopicAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetTopicAttributes.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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 rubrique
Pour mettre à jour les propriétés d'une seule rubrique existante, utilisez l'[SetTopicAttributes](https://docs.aws.amazon.com/sns/latest/api/API_SetTopicAttributes.html)opération.
Vous ne pouvez définir que les attributs `Policy`, `DisplayName` et `DeliveryPolicy`.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**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 AWS SDK pour PHP la version 3
Utilisez les rubriques Amazon Simple Notification Service (Amazon SNS) pour envoyer des notifications à Amazon Simple Queue Service (Amazon SQS), HTTP/HTTPS, adresses e-mail, (), ou. AWS Server Migration Service AWS SMS AWS Lambda
Les abonnements sont attachés à une rubrique qui gère l’envoi de messages aux abonnés. Pour en savoir plus sur la création de rubriques, [consultez la section Gestion des rubriques dans Amazon SNS avec la AWS SDK pour PHP version 3](sns-examples-managing-topics.md).
Les exemples suivants montrent comment :
+ S’abonner à une rubrique existante à l’aide de [Subscribe](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#subscribe).
+ Vérifiez un abonnement à l'aide de [ConfirmSubscription](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#confirmsubscription).
+ Répertoriez les abonnements existants en utilisant [ListSubscriptionsByTopic](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listsubscriptionsbytopic).
+ Supprimer un abonnement à l’aide de [Unsubscribe](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#unsubscribe).
+ Envoyer un message à tous les abonnés d’une rubrique à l’aide de [Publish](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#publish).
Pour plus d'informations sur l'utilisation d'Amazon SNS, consultez la section [Utilisation d'Amazon System-to-System SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-system-to-system-messaging.html) pour la messagerie.
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Abonner une adresse e-mail à une rubrique
Pour lancer un abonnement à une adresse e-mail, utilisez l’opération [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Vous pouvez utiliser la méthode subscribe pour abonner plusieurs points de terminaison différents à une rubrique Amazon SNS, en fonction des valeurs utilisées pour les paramètres transmis. Cette action est présentée dans 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**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$protocol = 'email';
$endpoint = 'sample@example.com';
$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());
}
```
## Abonnement d'un point de terminaison d'application à une rubrique
Pour lancer un abonnement à une application Web, utilisez l’opération [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Vous pouvez utiliser la méthode subscribe pour abonner plusieurs points de terminaison différents à une rubrique Amazon SNS, en fonction des valeurs utilisées pour les paramètres transmis. Cette action est présentée dans d’autres exemples de cette rubrique.
Dans cet exemple, le point de terminaison est une URL. Un jeton de confirmation est envoyé à cette adresse Web. Vérifiez l’abonnement avec ce jeton de confirmation dans un délai de trois jours à compter de la réception.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$protocol = 'https';
$endpoint = 'https://';
$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 une fonction Lambda à une rubrique
Pour initier un abonnement à une fonction Lambda, utilisez l'opération [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Vous pouvez utiliser la méthode subscribe pour abonner plusieurs points de terminaison différents à une rubrique Amazon SNS, en fonction des valeurs utilisées pour les paramètres transmis. Cette action est présentée dans d’autres exemples de cette rubrique.
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**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$protocol = 'lambda';
$endpoint = 'arn:aws:lambda:us-east-1:123456789023:function:messageStore';
$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());
}
```
## Abonnement d'un SMS à un sujet
Pour envoyer des messages SMS à plusieurs numéros de téléphone en même temps, abonnez chaque numéro à une rubrique.
Pour lancer un abonnement à un numéro de téléphone, utilisez l’opération [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Vous pouvez utiliser la méthode subscribe pour abonner plusieurs points de terminaison différents à une rubrique Amazon SNS, en fonction des valeurs utilisées pour les paramètres transmis. Cette action est présentée dans d’autres exemples de cette rubrique.
Dans cet exemple, le point de terminaison est un numéro de téléphone au format E.164, une norme internationale de télécommunications.
Un jeton de confirmation est envoyé à ce numéro de téléphone. Vérifiez l’abonnement avec ce jeton de confirmation dans un délai de trois jours à compter de la réception.
Pour une autre méthode d'envoi de SMS avec Amazon SNS, consultez la section [Envoi de messages SMS dans Amazon SNS avec AWS SDK pour PHP](sns-examples-sending-sms.md) la version 3.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Confirmer l'abonnement à un sujet
Pour créer un abonnement, le propriétaire du point de terminaison doit confirmer l’intention de recevoir des messages 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 trois jours, vous pouvez renvoyer un jeton en créant un nouvel abonnement.
Pour confirmer un abonnement, utilisez l'[ConfirmSubscription](https://docs.aws.amazon.com/sns/latest/api/API_ConfirmSubscription.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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->confirmSubscription([
'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 rubrique
Pour répertorier jusqu'à 100 abonnements existants dans une AWS région donnée, utilisez l'[ListSubscriptions](https://docs.aws.amazon.com/sns/latest/api/API_ListSubscriptions.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'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 rubrique
Pour supprimer un point de terminaison abonné à une rubrique, utilisez l’opération [Unsubscribe](https://docs.aws.amazon.com/sns/latest/api/API_Unsubscribe.html).
Si l'abonnement nécessite une authentification pour être supprimé, seul le propriétaire de l'abonnement ou le propriétaire du sujet peut se désabonner, et une AWS signature est requise. Si l'appel de désabonnement ne nécessite pas l'authentification et si le demandeur n'est pas le propriétaire de l'abonnement, un message d'annulation final est remis au point de terminaison.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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 sur une rubrique Amazon SNS
Pour envoyer un message à chaque point de terminaison abonné à une rubrique Amazon SNS, utilisez l'opération [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
Créez un objet contenant les paramètres de publication d'un message, notamment le texte du message et le nom de ressource Amazon (ARN) de la rubrique Amazon SNS.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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());
}
```
# Envoyer des SMS sur Amazon SNS avec la version 3 AWS SDK pour PHP
Vous pouvez utiliser Amazon Simple Notification Service (Amazon SNS) pour envoyer des SMS, ou des 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éphone simultanément en abonnant ces numéros de téléphone à une rubrique et en envoyant votre message à la rubrique.
Utilisez Amazon SNS pour définir vos préférences en matière de messagerie SMS, telles que la manière dont vos envois sont optimisés (en termes de coût ou de fiabilité), votre limite de dépenses mensuelles, la manière dont les envois de messages sont enregistrés et si vous souhaitez vous abonner aux rapports quotidiens d'utilisation des SMS. Ces préférences sont récupérées et définies sous forme d'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 norme pour 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 par le caractère plus (\$1) et le code pays. Par exemple, un numéro de téléphone américain au format E.164 s'affichera sous la forme \$11001 0100XXX555.
Les exemples suivants montrent comment :
+ Récupérez les paramètres par défaut pour l'envoi de SMS depuis votre compte à l'aide de [Get SMSAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#getsmsattributes).
+ Mettez à jour les paramètres par défaut pour l'envoi de SMS depuis votre compte à l'aide de [Set SMSAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#setsmsattributes).
+ Découvrez si le propriétaire d'un numéro de téléphone donné a choisi de ne pas recevoir de SMS de votre compte en utilisant [CheckIfPhoneNumberISOptedOut](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#checkifphonenumberisoptedout).
+ Répertoriez les numéros de téléphone pour lesquels le propriétaire a choisi de ne pas recevoir de SMS de votre compte en utilisant [ListPhoneNumberOptedOut](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](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#publish).
Pour plus d'informations sur l'utilisation d'Amazon SNS, consultez [Utilisation d'Amazon SNS pour les notifications aux utilisateurs ayant un numéro de téléphone portable en tant qu'abonné (](https://docs.aws.amazon.com/sns/latest/dg/sns-mobile-phone-number-as-subscriber.html)envoi de SMS).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Obtenir les attributs des SMS
Pour récupérer les paramètres par défaut des messages SMS, utilisez l'SMSAttributesopération [Obtenir](https://docs.aws.amazon.com/sns/latest/api/API_GetSMSAttributes.html).
Cet exemple permet d’obtenir l’attribut `DefaultSMSType`. Cet attribut contrôle si les messages SMS sont envoyés en tant que `Promotional`, ce qui optimise la transmission des messages au plus bas coût ou en tant que `Transactional`, ce qui optimise la transmission des messages à une fiabilité optimale.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
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 SMS
Pour mettre à jour les paramètres par défaut des messages SMS, utilisez l'SMSAttributesopération [Set](https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html).
Cet exemple définit l’attribut `DefaultSMSType` sur `Transactional`, ce qui optimise la transmission de message à une fiabilité optimale.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
try {
$result = $SnSclient->SetSMSAttributes([
'attributes' => [
'DefaultSMSType' => 'Transactional',
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Vérifiez si un numéro de téléphone s'est désinscrit
Pour déterminer si le propriétaire d'un numéro de téléphone donné a choisi de ne pas recevoir de SMS depuis votre compte, utilisez cette [CheckIfPhoneNumberIsOptedOut](https://docs.aws.amazon.com/sns/latest/api/API_CheckIfPhoneNumberIsOptedOut.html)opération.
Dans cet exemple, le numéro de téléphone est au format E.164, une norme internationale de télécommunications.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$phone = '+1XXX5550100';
try {
$result = $SnSclient->checkIfPhoneNumberIsOptedOut([
'phoneNumber' => $phone,
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Répertorier les numéros de téléphone désactivés
Pour récupérer la liste des numéros de téléphone pour lesquels le propriétaire a choisi de ne pas recevoir de SMS depuis votre compte, utilisez cette [ListPhoneNumbersOptedOut](https://docs.aws.amazon.com/sns/latest/api/API_ListPhoneNumbersOptedOut.html)opération.
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
try {
$result = $SnSclient->listPhoneNumbersOptedOut();
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Publier dans un message texte (message SMS)
Pour diffuser un message texte (SMS) directement à un numéro de téléphone, utilisez l’opération [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
Dans cet exemple, le numéro de téléphone est au format E.164, une norme internationale de télécommunications.
Les messages SMS peuvent contenir jusqu’à 140 octets. La limite de taille pour une action de publication de SMS est de 1 600 octets.
Pour plus d’informations sur l’envoi de messages SMS, consultez la section [Envoi d’un message SMS](https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html).
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Exemple de code**
```
$SnSclient = new SnsClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2010-03-31'
]);
$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 d'Amazon SQS utilisant la version 3 AWS SDK pour PHP
Amazon Simple Queue Service (SQS) est un service de mise en file d'attente de messages rapide, fiable, évolutif et entièrement géré. Amazon SQS vous permet de dissocier les composants d'une application cloud. Amazon SQS inclut des files d'attente standard avec un débit et un at-least-once traitement élevés, ainsi que des files d'attente FIFO qui fournissent une livraison FIFO (first>-in, first>out) et un traitement en une seule fois.
Tous les exemples de code pour la AWS SDK pour PHP version 3 sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Permettre les longs sondages](sqs-examples-enable-long-polling.md)
+ [Gérer le délai d'expiration de la visibilité](sqs-examples-managing-visibility-timeout.md)
+ [Envoyer et recevoir des messages](sqs-examples-send-receive-messages.md)
+ [Utilisation des files d’attente de lettres mortes](sqs-examples-dead-letter-queues.md)
+ [Utilisation de files d'attente](sqs-examples-using-queues.md)
# Activation des longues interrogations dans Amazon SQS avec AWS SDK pour PHP la version 3
Les longues interrogations réduisent le nombre de réponses vides en permettant à Amazon SQS d'attendre pendant un certain temps qu'un message soit disponible dans la file d'attente avant d'envoyer une réponse. L'attente active de longue durée élimine également les fausses réponses vides en interrogeant tous les serveurs, à la place d'un simple échantillon. Pour activer l'attente active de longue duré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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html).
Les exemples suivants montrent comment :
+ Définissez les attributs d'une file d'attente Amazon SQS pour permettre un long sondage, en utilisant. [SetQueueAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#setqueueattributes)
+ Récupérez un ou plusieurs messages présentant un long sondage à l'aide de [ReceiveMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#receivemessage).
+ Créez une longue file d'attente de sondage à l'aide de [CreateQueue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#createqueue).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Définissez les attributs d'une file d'attente pour permettre un long sondage
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$queueUrl = "QUEUE_URL";
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
try {
$result = $client->setQueueAttributes([
'Attributes' => [
'ReceiveMessageWaitTimeSeconds' => 20
],
'QueueUrl' => $queueUrl, // REQUIRED
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Récupérez les messages soumis à de longues interrogations
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$queueUrl = "QUEUE_URL";
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
try {
$result = $client->receiveMessage([
'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éation d'une file d'attente avec un long sondage
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$queueName = "QUEUE_NAME";
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
try {
$result = $client->createQueue([
'QueueName' => $queueName,
'Attributes' => [
'ReceiveMessageWaitTimeSeconds' => 20
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# Gestion des délais de visibilité dans Amazon SQS AWS SDK pour PHP avec la version 3
Un délai de visibilité est une période pendant laquelle Amazon SQS empêche les autres composants consommateurs de recevoir et de traiter un message. Pour en savoir plus, consultez [Délai de visibilité](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html).
L’exemple suivant indique comment :
+ Modifiez le délai de visibilité des messages spécifiés dans une file d'attente par de nouvelles valeurs, en utilisant [ChangeMessageVisibilityBatch](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#changemessagevisibilitybatch).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Modifier le délai de visibilité de plusieurs messages
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**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'],
'MaxNumberOfMessages' => 10,
'MessageAttributeNames' => ['All'],
'QueueUrl' => $queueUrl, // REQUIRED
));
$messages = $result->get('Messages');
if ($messages != null) {
$entries = array();
for ($i = 0; $i < count($messages); $i++) {
$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());
}
```
# Envoyer et recevoir des messages dans Amazon SQS avec AWS SDK pour PHP la version 3
Pour en savoir plus sur les messages Amazon SQS, consultez les sections [Envoyer un message à une file d'attente SQS et Recevoir et supprimer un message d'une file](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-send-message.html) [d'attente SQS dans le Guide de l'utilisateur de Service Quotas](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-receive-delete-message.html.html).
Les exemples suivants montrent comment :
+ Envoyez un message à une file d'attente spécifiée à l'aide de [SendMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#sendmessage).
+ Récupérez un ou plusieurs messages (jusqu'à 10) d'une file d'attente spécifiée à l'aide de [ReceiveMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#receivemessage).
+ Supprimez un message d'une file d'attente à l'aide de [DeleteMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#deletemessage).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Envoyer un message
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
$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 messages
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$queueUrl = "QUEUE_URL";
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
try {
$result = $client->receiveMessage([
'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 de files d'attente contenant des lettres mortes dans Amazon SQS avec la version 3 AWS SDK pour PHP
Une file d'attente de lettres mortes peut être ciblée par d'autres files d'attente (source) pour les messages ne pouvant pas être traités avec succès. Vous pouvez mettre de côté et isoler ces messages dans la file d’attente de lettres mortes pour déterminer pourquoi leur traitement a échoué. Vous devez configurer individuellement chaque file d’attente source qui envoie des messages à une file d’attente de lettres mortes. 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html).
L’exemple suivant indique comment :
+ Activez une file d'attente de lettres mortes à l'aide de. [SetQueueAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#setqueueattributes)
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Activer une file d'attente de lettres mortes
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$queueUrl = "QUEUE_URL";
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
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 de files d'attente dans Amazon SQS AWS SDK pour PHP avec la version 3
Pour en savoir plus sur les files d'attente Amazon SQS, consultez [Comment fonctionnent les files d'attente SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-how-it-works.html).
Les exemples suivants montrent comment :
+ Renvoie une liste de vos files d'attente en utilisant [ListQueues](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#listqueues).
+ Créez une nouvelle file d'attente en utilisant [CreateQueue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#createqueue).
+ Renvoie l'URL d'une file d'attente existante en utilisant [GetQueueUrl](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#getqueueurl).
+ Supprimez une file d'attente spécifiée à l'aide de [DeleteQueue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#deletequeue).
Tous les exemples de code pour le AWS SDK pour PHP sont [disponibles ici GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Informations d’identification
Avant d'exécuter l'exemple de code, configurez vos AWS informations d'identification, comme décrit dans[Authentification à l' AWS aide de AWS SDK pour PHP la version 3](credentials.md). Importez ensuite le AWS SDK pour PHP, comme décrit dans[Installation de la AWS SDK pour PHP version 3](getting-started_installation.md).
## Renvoie une liste de files d'attente
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
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éer une file d'attente
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Exemple de code**
```
$queueName = "SQS_QUEUE_NAME";
$client = new SqsClient([
'profile' => 'default',
'region' => 'us-west-2',
'version' => '2012-11-05'
]);
try {
$result = $client->createQueue([
'QueueName' => $queueName,
'Attributes' => [
'DelaySeconds' => 5,
'MaximumMessageSize' => 4096, // 4 KB
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
## Renvoie l'URL d'une file d'attente
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**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'attente
**Importations**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**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());
}
```
# Envoyez des événements aux points de terminaison EventBridge mondiaux Amazon à l'aide de la AWS SDK pour PHP version 3
Vous pouvez utiliser les [points de terminaison EventBridge mondiaux Amazon](https://docs.aws.amazon.com//eventbridge/latest/userguide/eb-global-endpoints.html) pour améliorer la disponibilité et la fiabilité de vos applications basées sur les événements.
Une fois le point de terminaison EventBridge global [configuré](https://docs.aws.amazon.com//eventbridge/latest/userguide/eb-global-endpoints.html#eb-ge-create-endpoint), vous pouvez lui envoyer des événements à l'aide du SDK for PHP.
**Important**
Pour utiliser des points de terminaison EventBridge globaux avec le SDK for PHP, l'extension [Common Runtime AWS (CRT) doit être installée AWS dans](guide_crt.md) votre environnement PHP.
L'exemple suivant utilise la [PutEvents](https://docs.aws.amazon.com//aws-sdk-php/v3/api/api-eventbridge-2015-10-07.html#putevents)méthode du `EventBridgeClient` pour envoyer un événement unique à un point de terminaison EventBridge global.
```
'us-east-1'
]);
$endpointId = 'xxxx123456.xxx'; // Existing EventBridge global endpointId.
$eventBusName = 'default'; // Existing event bus in the us-east-1 Region.
$event = [
'Source' => 'my-php-app',
'DetailType' => 'test',
'Detail' => json_encode(['foo' => 'bar']),
'Time' => new DateTime(),
'Resources' => ['php-script'],
'EventBusName' => $eventBusName,
'TraceHeader' => 'test'
];
$result = $evClient->putEvents([
'EndpointId' => $endpointId,
'Entries' => [$event]
]);
```
[Ce billet de blog](https://aws.amazon.com/blogs//compute/introducing-global-endpoints-for-amazon-eventbridge/) contient plus d'informations sur les points de terminaison EventBridge globaux.