',
'Time' => time()
],
],
]);
var_dump($result);
} catch (AwsException $e) {
// output error message if fails
error_log($e->getMessage());
}
```
# Uso de acciones de alarma con las alarmas de Amazon CloudWatch con AWS SDK para PHP versión 3
Use acciones de alarma para crear alarmas que detengan, terminen, reinicien o recuperen automáticamente sus instancias de Amazon EC2. Puede utilizar las acciones parar o terminar cuando ya no necesita que se ejecute una instancia. Puede usar las acciones reiniciar y recuperar para reiniciar automáticamente esas instancias.
Los siguientes ejemplos muestran cómo:
+ Habilitar acciones para alarmas específicas utilizando [EnableAlarmActions](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#enablealarmactions).
+ Deshabilitar acciones para alarmas específicas utilizando [DisableAlarmActions](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-monitoring-2010-08-01.html#disablealarmactions).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Habilitación de acciones de alarma
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\CloudWatch\CloudWatchClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
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();
```
## Deshabilitación de acciones de alarma
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\CloudWatch\CloudWatchClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
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();
```
# Ejemplos de Amazon EC2 utilizando la versión 3 de AWS SDK para PHP
Amazon Elastic Compute Cloud (Amazon EC2) es un servicio web que proporciona hosting de servidores virtuales en la nube. Se ha diseñado para facilitar a los desarrolladores la computación en nube a escala web, proporcionando capacidad de cálculo ajustable.
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
**Topics**
+ [Credenciales](#examplecredentials)
+ [Administración de instancias Amazon EC2](ec2-examples-managing-instances.md)
+ [Uso de direcciones IP elásticas](ec2-examples-using-elastic-ip-addresses.md)
+ [Uso de regiones y zonas de disponibilidad](ec2-examples-using-regions-and-zones.md)
+ [Uso de pares de claves](ec2-examples-working-with-key-pairs.md)
+ [Uso de grupos de seguridad](ec2-examples-using-security-groups.md)
# Administración de instancias de Amazon EC2 con la versión 3 de AWS SDK para PHP
Los siguientes ejemplos muestran cómo:
+ Describir instancias EC2 utilizando [DescribeInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeinstances).
+ Habilitar el monitoreo detallado de una instancia en ejecución utilizando [MonitorInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#monitorinstances).
+ Deshabilitar el monitoreo de una instancia en ejecución utilizando [UnmonitorInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#unmonitorinstances).
+ Inicie una AMI basada en Amazon EBS que haya detenido previamente, utilizando [StartInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#startinstances).
+ Detenga una instancia basada en Amazon EBS utilizando [StopInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#stopinstances).
+ Solicitar un reinicio de una o varias instancias utilizando [RebootInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#rebootinstances).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Descripción de instancias
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Ec2\Ec2Client;
```
**Código de muestra**
```
$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";
}
}
```
## Habilitar y deshabilitar el monitoreo
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
## Iniciar y detener una instancia
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
## Reinicio de una instancia
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
# Uso de direcciones IP elásticas con Amazon EC2 con AWS SDK para PHP la versión 3
Una dirección IP elástica (EIP) es una dirección IP estática diseñada para la informática en la nube dinámica. Hay una dirección IP elástica asociada a su. Cuenta de AWS Se trata de una dirección IP pública a la que se puede obtener acceso desde Internet. Si la instancia no tiene una dirección IP pública, puede asociar una dirección IP elástica (EIP) a la instancia para permitir la comunicación con Internet.
Los siguientes ejemplos muestran cómo:
+ Describa una o más de sus instancias utilizando [DescribeInstances](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeinstances).
+ Adquiera una dirección IP elástica mediante [AllocateAddress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#allocateaddress).
+ Asocie una dirección IP elástica a una instancia mediante [AssociateAddress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#associateaddress).
+ Libere una dirección IP elástica mediante [ReleaseAddress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#releaseaddress).
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Describir una instancia
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Ec2\Ec2Client;
```
**Código de muestra**
```
$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";
}
}
```
## Asignar y asociar una dirección
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
## Liberar una dirección
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
# Uso de las regiones y las zonas de disponibilidad de con el versión 3
Amazon EC2 está alojado en varias ubicaciones de todo el mundo. Dichas ubicaciones se componen de regiones de AWS y zonas de disponibilidad. Cada Región es un área geográfica independiente, que tiene varias ubicaciones aisladas conocidas como zonas de disponibilidad. Amazon EC2; ofrece la posibilidad de colocar instancias y datos en varias ubicaciones.
Los siguientes ejemplos muestran cómo:
+ Describir las zonas de disponibilidad que están disponibles utilizando [DescribeAvailabilityZones](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeavailabilityzones).
+ Describir las regiones de AWS que están disponibles actualmente utilizand [DescribeRegions](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describeregions).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Describir zonas de disponibilidad
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeAvailabilityZones();
var_dump($result);
```
## Describir regiones
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeRegions();
var_dump($result);
```
# Uso de pares de claves de Amazon EC2 utilizando la versión 3 de AWS SDK para PHP
Amazon EC2 utiliza la criptografía de clave pública para cifrar y descifrar la información de inicio de sesión. En la criptografía de clave pública se utiliza una clave pública para cifrar los datos. A continuación, el destinatario utiliza la clave privada para descifrar los datos. El conjunto de clave pública y clave privada se denomina par de claves.
Los siguientes ejemplos muestran cómo:
+ Crear un par de claves RSA de 2048 bits utilizando [CreateKeyPair](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#createkeypair).
+ Eliminar un par de claves utilizando [DeleteKeyPair](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#deletekeypair).
+ Describir uno o varios pares de claves utilizando [DescribeKeyPairs](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describekeypairs).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Crear un par de claves
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
## Eliminar un par de claves
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
## Describir pares de claves
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeKeyPairs();
var_dump($result);
```
# Uso de los grupos de seguridad en Amazon EC2 utilizando la versión 3 de AWS SDK para PHP
Un grupo de seguridad de Amazon EC2 funciona como un firewall virtual que controla el tráfico de una o varias instancias. Se añaden reglas a cada grupo de seguridad para permitir el tráfico con sus instancias asociadas. Puede modificar las reglas de un grupo de seguridad en cualquier momento. Las nuevas reglas se aplican automáticamente a todas las instancias asociadas al grupo de seguridad.
Los siguientes ejemplos muestran cómo:
+ Describir uno o varios de los grupos de seguridad utilizando [DescribeSecurityGroups](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#describesecuritygroups).
+ Añadir una regla de entrada a un grupo de seguridad utilizando [AuthorizeSecurityGroupIngress](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#authorizesecuritygroupingress).
+ Crear un grupo de seguridad utilizando [CreateSecurityGroup](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#createsecuritygroup).
+ Eliminar un grupo de seguridad utilizando [DeleteSecurityGroup](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-ec2-2016-11-15.html#deletesecuritygroup).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Describir grupos de seguridad
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$ec2Client = new Aws\Ec2\Ec2Client([
'region' => 'us-west-2',
'version' => '2016-11-15',
'profile' => 'default'
]);
$result = $ec2Client->describeSecurityGroups();
var_dump($result);
```
## Añadir una regla de entrada
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
## Creación de un grupo de seguridad
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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';
```
## Eliminación de un grupo de seguridad
**Importaciones**
```
require 'vendor/autoload.php';
```
**Código de muestra**
```
$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);
```
# Firmar una solicitud de búsqueda de Amazon OpenSearch Service con la versión 3 de AWS SDK para PHP
Amazon OpenSearch Service facilita es un servicio administrado que facilita la implementación, el funcionamiento y el escalado de Amazon OpenSearch Service, un popular motor de búsqueda y análisis de código abierto. OpenSearch Service ofrece acceso directo a la API de Amazon OpenSearch Service. Esto significa que los desarrolladores pueden utilizar las herramientas con las que están familiarizados, así como sólidas opciones de seguridad. Muchos clientes de Amazon OpenSearch Service son compatibles con la firma de solicitudes, pero si utiliza un cliente que no lo es, puede firmar solicitudes PSR-7 arbitrarias con los proveedores de credenciales y firmantes integrados de la plataforma .
Los siguientes ejemplos muestran cómo:
+ Firmar una solicitud con el protocolo de firma de AWS utilizando [SignatureV4](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Signature.SignatureV4.html#_signRequest).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Firmar una solicitud de OpenSearch Service
OpenSearch Service utiliza [la versión 4 de la firma](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). Esto significa que necesita firmar las peticiones con el nombre de la firma del servicio (en este caso `es`) y la región de AWS de su dominio OpenSearch Service. Encontrará una lista completa de las regiones compatibles con OpenSearch Service en la AWS página de regiones y puntos de conexión de la Referencia general de Amazon Web Services. Sin embargo, en este ejemplo, vamos a firmar solicitudes dirigidas a un dominio de OpenSearch Service de la región de `us-west-2`.
Tiene que proporcionar credenciales, lo que puede hacer con la cadena de proveedor predeterminada del SDK o con cualquiera de los formatos de credenciales que se describen en [Credenciales para la versión 3 de AWS SDK para PHP](guide_credentials.md). También necesitará una [solicitud PSR-7](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Psr.Http.Message.RequestInterface.html) (que en el código siguiente se presupone que se llama `$psr7Request`).
```
// 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);
```
# AWS Identity and Access ManagementEjemplos de en los que se utiliza la versión 3 de AWS SDK para PHP
AWS Identity and Access Management (IAM) es un servicio web que permite a los clientes de Amazon Web Services administrar usuarios y permisos de usuario en AWS. El servicio está dirigido a las organizaciones con múltiples usuarios o sistemas en la nube que utilizan productos de AWS. Con IAM, puede administrar de forma centralizada los usuarios, las credenciales de seguridad, como las claves de acceso, y los permisos que controlan los recursos de AWS a los que pueden acceder los usuarios.
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
**Topics**
+ [Credenciales](#examplecredentials)
+ [Administración de las claves de acceso de IAM](iam-examples-managing-access-keys.md)
+ [Administración de usuarios de IAM](iam-examples-managing-users.md)
+ [Uso de alias de cuenta de IAM](iam-examples-using-account-aliases.md)
+ [Uso de políticas de IAM](iam-examples-working-with-policies.md)
+ [Uso de certificados de servidor de IAM](iam-examples-working-with-certs.md)
# Administración de claves de acceso IAM con la versión 3 de AWS SDK para PHP
Los usuarios necesitan sus propias claves de acceso para realizar llamadas por programa a AWS. Para atender esta necesidad, puede crear, modificar, ver o rotar claves de acceso (ID de clave de acceso y claves de acceso secretas) de los usuarios de IAM. De forma predeterminada, cuando se crea una clave de acceso, su estado es activo. Esto significa que el usuario puede utilizar la clave de acceso para realizar llamadas a la API.
Los siguientes ejemplos muestran cómo:
+ Crear una clave de acceso secreta y el ID de clave de acceso correspondiente con [CreateAccessKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createaccesskey).
+ Devolver información sobre el ID de clave de acceso asociado a un usuario de IAM con [ListAccessKeys](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listaccesskeys).
+ Obtener información sobre el último uso de una clave de acceso con [GetAccessKeyLastUsed](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getaccesskeylastused).
+ Cambiar el estado de una clave de acceso de activa a inactiva o viceversa con [UpdateAccessKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateaccesskey).
+ Eliminar un par de claves de acceso asociado a un usuario de IAM con [DeleteAccessKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteaccesskey).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Creación de una clave de acceso
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Mostrar claves de acceso
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Obtener más información el último uso de una clave de acceso
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Actualizar una clave de acceso
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminación de una clave de acceso
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
# Administración de usuarios IAM con AWS SDK para PHP; versión 3
Un usuario IAM es la identidad que se crea en AWS para representar a la persona o servicio que lo utiliza para interactuar con AWS. Un usuario de AWS consta de un nombre y credenciales.
Los siguientes ejemplos muestran cómo:
+ Crear un nuevo usuario de IAM utilizando [CreateUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createuser).
+ Enumerar los usuarios de IAM utilizando [ListUsers](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listusers).
+ Actualizar un usuario de IAM utilizando [UpdateUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateuser).
+ Recuperar información acerca de un usuario de IAM utilizando [GetUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getuser).
+ Eliminar un usuario de IAM utilizando [DeleteUser](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteuser).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Creación de un usuario de IAM
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Enumerar usuarios de IAM
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Actualizar un usuario de IAM
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Obtener información acerca de un usuario de IAM
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminar un usuario de IAM
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
# Uso de alias de cuentas IAM con la versión 3 de AWS SDK para PHP
Si quiere que la dirección URL de la página de inicio de sesión contenga el nombre de su empresa u otro identificador intuitivo en lugar de su ID de Cuenta de AWS, puede crear un alias para el ID de Cuenta de AWS. Si crea un alias de Cuenta de AWS, la dirección URL de su página de inicio de sesión cambia para incorporar dicho alias.
Los siguientes ejemplos muestran cómo:
+ Crear un alias utilizando [CreateAccountAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createaccountalias).
+ Crear una lista de los alias asociados a Cuenta de AWS utilizando [ListAccountAliases](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listaccountaliases).
+ Eliminar un alias utilizando [DeleteAccountAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteaccountalias).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Creación de un alias
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Mostrar alias de cuenta
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminar un alias
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
# Uso de políticas IAM con la versión 3 de AWS SDK para PHP
Los permisos a un usuario se conceden mediante la creación de una política. Una política es un documento que incluye una lista de las acciones que puede realizar un usuario y los recursos a los que pueden afectar dichas acciones. De forma predeterminada, todas las acciones o recursos que no se permiten de forma explícita se rechazan. Puede crear políticas y asociarlas a usuarios, a grupos de usuarios, a roles asumidos por usuarios y a recursos.
Los siguientes ejemplos muestran cómo:
+ Crear una política administrada utilizando [CreatePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#createpolicy).
+ Asociar una política a un rol utilizando [AttachRolePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachrolepolicy).
+ Asociar una política a un usuario utilizando [AttachUserPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachuserpolicy).
+ Asociar una política a un grupo utilizando [AttachGroupPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#attachgrouppolicy).
+ Quitar una política de rol utilizando [DetachRolePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachrolepolicy).
+ Quitar una política de usuario utilizando [DetachUserPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachuserpolicy).
+ Quitar una política de grupo utilizando [DetachGroupPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#detachgrouppolicy).
+ Eliminar una política administrada utilizando [DeletePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deletepolicy).
+ Eliminar una política de rol utilizando [DeleteRolePolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleterolepolicy).
+ Eliminar una política de usuario utilizando [DeleteUserPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteuserpolicy).
+ Eliminar una política de grupo utilizando [DeleteGroupPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deletegrouppolicy).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Crear una política.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Asociación de una política a un rol
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Asociar una política a un usuario
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Asociación de una política a un grupo
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Desasociación de una política de usuario
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Desasociación de una política de grupo
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminar una política
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminación de una política de rol
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminación de una política de usuario
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminación de una política de grupo
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
# Uso de certificados de servidor IAM con la versión 3 de AWS SDK para PHP
Para habilitar las conexiones HTTPS en su sitio web o aplicación en AWS, necesita un certificado de servidor SSL/TLS. Para utilizar un certificado obtenido de un proveedor externo con su sitio web o aplicación en AWS, debe cargar el certificado en IAM o importarlo a AWS Certificate Manager.
Los siguientes ejemplos muestran cómo:
+ Elaborar una lista de los certificados almacenados en IAM utilizando [ListServerCertificates](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#listservercertificates).
+ Recuperar información sobre un certificado utilizando [GetServerCertificate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#getservercertificate).
+ Actualizar un certificado utilizando [UpdateServerCertificate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#updateservercertificate).
+ Eliminar un certificado utilizando [DeleteServerCertificate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-iam-2010-05-08.html#deleteservercertificate).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Elaborar listas de certificados de servidor
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Recuperar un certificado de servidor
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Actualizar un certificado de servidor
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminar un certificado de servidor
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Iam\IamClient;
```
**Código de muestra**
```
$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 ServiceEjemplos de en los que se utiliza la versión 3 de AWS SDK para PHP
AWS Key Management Service (AWS KMS) es un servicio administrado que le permite crear y controlar fácilmente las claves de cifrado que se utilizan para cifrar datos. Para obtener más información acerca de AWS KMS, consulte la [documentación de Amazon KMS](https://aws.amazon.com/documentation/kms/). Tanto si escribe aplicaciones seguras para PHP como si envía datos a otros servicios de AWS, AWS KMS le ayuda a mantener el control sobre quién puede usar las claves maestras y obtener acceso a sus datos cifrados.
Todo el código de ejemplo de la versión 3 de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Trabajo con claves](kms-example-keys.md)
+ [Cifrar y descifrar claves de datos](kms-example-encrypt.md)
+ [Trabajar con las políticas de claves](kms-example-key-policy.md)
+ [Trabajar con concesiones](kms-example-grants.md)
+ [Trabajar con alias](kms-example-alias.md)
# Trabajar con claves mediante la AWS KMS API y la AWS SDK para PHP versión 3
Los recursos principales de AWS Key Management Service (AWS KMS) son [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). Puede usar una clave KMS para cifrar sus datos.
Los siguientes ejemplos muestran cómo:
+ Cree una clave KMS de cliente utilizando [CreateKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#createkey).
+ Genere una clave de datos utilizando [GenerateDataKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#generatedatakey).
+ Vea una clave KMS usando [DescribeKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#describekey).
+ Obtenga la clave IDs y el ARN clave de las claves de KMS utilizando [ListKeys](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listkeys).
+ Habilite las claves KMS usando [EnableKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#enablekey).
+ Deshabilite las claves KMS mediante [DisableKey](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#disablekey).
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de AWS Key Management Service (AWS KMS), consulte la [Guía del AWS KMS desarrollador](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Crear una clave de KMS.
Para crear una [clave KMS](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys), utilice la [CreateKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Generar una clave de datos
Para generar una clave de cifrado de datos, utilice la [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html)operación. Esta operación devuelve copias en texto no cifrado y cifradas de la clave de datos que crea. Especifique la base AWS KMS key con la que se generará la clave de datos.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Ver una clave KMS
Para obtener información detallada sobre una clave de KMS, incluidos el nombre de recurso de Amazon (ARN) y el [estado de la clave](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html), utilice la [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)operación.
`DescribeKey` no obtiene los alias. Para obtener los alias, utilice la [ListAliases](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Obtenga el identificador de clave y la clave ARNs de una clave de KMS
Para obtener el ID y el ARN de la clave KMS, utilice la [ListAliases](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Habilitar una clave KMS
Para habilitar una clave KMS deshabilitada, utilice la [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Deshabilitar una clave KMS
Para deshabilitar una clave KMS, utilice la [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html)operación. Al deshabilitar una clave KMS se impide que se utilice.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Cifrado y descifrado de claves de AWS KMS datos con la versión 3 AWS SDK para PHP
Las claves de datos son las claves de cifrado que puede utilizar para cifrar los datos, incluidas grandes cantidades de datos y otras claves de cifrado de datos.
Puedes usar AWS Key Management Service an's (AWS KMS) [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)para generar, cifrar y descifrar claves de datos.
Los siguientes ejemplos muestran cómo:
+ Cifrar una clave de datos mediante [Encrypt](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#encrypt).
+ Descifrar una clave de datos mediante [Decrypt](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#decrypt).
+ Vuelva a cifrar una clave de datos con una nueva clave de KMS mediante. [ReEncrypt](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#reencrypt)
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en. GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code)
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de AWS Key Management Service (AWS KMS), consulte la [Guía del AWS KMS desarrollador](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Encrypt
La operación [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) se ha diseñado para cifrar claves de datos, pero no se utiliza con frecuencia. Las [GenerateDataKeyWithoutPlaintext](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html)operaciones [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html)y devuelven claves de datos cifradas. Podría utilizar el método `Encypt` cuando mueva datos cifrados a una nueva región de AWS y desee cifrar su clave de datos con una CMK en la nueva región.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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
Para descifrar una clave de datos, use la operación [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html).
El valor `ciphertextBlob` que especifique debe ser el valor del `CiphertextBlob` campo de una respuesta [GenerateDataKey[GenerateDataKeyWithoutPlaintext](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html)](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html), o de [Encrypt.](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html)
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Volver a cifrar
Para descifrar una clave de datos cifrada y volver a cifrarla inmediatamente con una clave KMS diferente, utilice la operación. [ReEncrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html) Las operaciones se realizan íntegramente desde el lado interno del servidor AWS KMS, por lo que nunca se expone el texto sin formato fuera de él. AWS KMS
El valor `ciphertextBlob` que especifique debe ser el valor del `CiphertextBlob` campo de una respuesta [GenerateDataKey[GenerateDataKeyWithoutPlaintext](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html)](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html), o [Encrypt.](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html)
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Trabajar con políticas AWS KMS clave mediante la AWS SDK para PHP versión 3
Cuando crea una [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys), determina quién puede usar y administrar esa clave KMS. Estos permisos se encuentran en un documento denominado la política de claves. Puede utilizar la política de claves para añadir, eliminar o modificar los permisos de una clave de KMS gestionada por el cliente en cualquier momento, pero no puede editar la política de claves de una clave de KMS AWS gestionada. Para obtener más información, consulte [Autenticación y control de acceso para AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/control-access.html).
Los siguientes ejemplos muestran cómo:
+ Enumere los nombres de las políticas clave que se utilizan [ListKeyPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listkeypolicies).
+ Obtenga una política clave utilizando [GetKeyPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#getkeypolicy).
+ Establezca una política clave utilizando [PutKeyPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#putkeypolicy).
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de AWS Key Management Service (AWS KMS), consulte la [Guía del AWS KMS desarrollador](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Enumerar todas las políticas de claves
Para obtener los nombres de las políticas de claves de una clave KMS, utilice la operación `ListKeyPolicies`.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Recuperar una política de claves
Para obtener la política de claves de una clave KMS, utilice la operación `GetKeyPolicy`.
`GetKeyPolicy` requiere un nombre de política. A menos que haya creado una política de claves al crear la clave KMS, el único nombre de política válido es el predeterminado. Obtenga más información sobre la [política de claves predeterminada](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html) en la *Guía para desarrolladores de AWS Key Management Service *.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Establecer una política de claves
Para establecer o cambiar una política de claves para una clave KMS, utilice la operación `PutKeyPolicy`.
`PutKeyPolicy` requiere un nombre de política. A menos que haya creado una política de claves al crear la clave KMS, el único nombre de política válido es el predeterminado. Obtenga más información sobre la [política de claves predeterminada](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html) en la *Guía para desarrolladores de AWS Key Management Service *.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Trabajar con subvenciones mediante la AWS KMS API y la AWS SDK para PHP versión 3
Una concesión es otro mecanismo para proporcionar permisos. Es una alternativa a la política de claves. Puedes utilizar las concesiones para conceder un acceso a largo plazo que permita a AWS los directores utilizar tu AWS Key Management Service (AWS KMS) gestionado por el cliente [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). Para obtener más información, consulte [Concesiones AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) en la*AWS Key Management Service Guía para desarrolladores*.
Los siguientes ejemplos muestran cómo:
+ Cree una concesión para una clave de KMS utilizando. [CreateGrant](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#creategrant)
+ Vea una concesión para una clave KMS utilizando [ListGrants](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listgrants).
+ Retira una concesión para una clave KMS utilizando [RetireGrant](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#retiregrant).
+ Revoca la concesión de una clave KMS mediante [RevokeGrant](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#revokegrant).
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de AWS Key Management Service (AWS KMS), consulte la [Guía del AWS KMS desarrollador](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Crear una concesión
Para crear una concesión para un AWS KMS key, utilice la [CreateGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Visualización de una concesión
Para obtener información detallada sobre las subvenciones de una AWS KMS key, utilice la [ListGrants](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListGrants.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Retirada de una concesión
Para retirar una subvención de un AWS KMS key, utilice la [RetireGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html)operación. Retire una concesión para efectuar una limpieza cuando termine de utilizarla.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Revocación de una concesión
Para revocar una concesión a un AWS KMS key, utilice la [RevokeGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html)operación. Puede revocar una concesión para denegar explícitamente las operaciones que dependen de ella.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Trabajar con alias mediante la AWS KMS API y la AWS SDK para PHP versión 3
AWS Key Management Service (AWS KMS) proporciona un nombre para mostrar opcional para un alias [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)denominado.
Los siguientes ejemplos muestran cómo:
+ Cree un alias utilizando [CreateAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#createalias).
+ Vea un alias usando [ListAliases](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#listaliases).
+ Actualiza un alias usando [UpdateAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#updatealias).
+ Elimine un alias utilizando [DeleteAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kms-2014-11-01.html#deletealias).
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de AWS Key Management Service (AWS KMS), consulte la [Guía del AWS KMS desarrollador](https://docs.aws.amazon.com/kms/latest/developerguide/).
## Creación de un alias de
Para crear un alias para una clave de KMS, utilice la [CreateAlias](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateAlias.html)operación. El alias debe ser único en la cuenta y AWS la región. Si crea un alias para una clave KMS que ya tiene un alias, `CreateAlias` crea otro alias para la misma clave KMS. No sustituye el alias existente.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Ver un alias
Para enumerar todos los alias de la persona que llama Cuenta de AWS Región de AWS, utilice la [ListAliases](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Actualizar un alias
Para asociar un alias existente a una clave de KMS diferente, utilice la [UpdateAlias](https://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateAlias.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminar un alias
Para eliminar un alias, utilice la [DeleteAlias](https://docs.aws.amazon.com/kms/latest/APIReference/API_DeleteAlias.html)operación. La eliminación de un alias no afecta a la clave KMS subyacente.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Ejemplos de Amazon Kinesis utilizando la versión 3 de AWS SDK para PHP
Amazon Kinesis es un servicio de AWS sue recopila, procesa y analiza datos en tiempo real. Configure los flujos de datos con Amazon Kinesis Data Streams o utilice Amazon Data Firehose para enviar datos a Amazon S3, OpenSearch Service, Amazon Redshift o Splunk.
Para obtener más información acerca de Kinesis, consulte la [documentación de Amazon Kinesis](https://docs.aws.amazon.com/kinesis/index.html).
Todo el código de ejemplo de la versión 3 de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Kinesis Data Streams](kinesis-example-data-stream.md)
+ [Fragmentos de Kinesis](kinesis-example-shard.md)
+ [Flujos de entregas de Kinesis Data Firehose](kinesis-firehose-example-delivery-stream.md)
# Creación de flujos de datos mediante la API de flujos de datos de Kinesis y la versión 3 de AWS SDK para PHP
Amazon Kinesis Data Streams le permite enviar datos en tiempo real. Cree un productor de datos con Kinesis Data Streams que entregue datos al destino configurado cada vez que añada datos.
Para obtener más información, consulte [Creación y administración de secuencias](https://docs.aws.amazon.com/kinesis/latest/dev/working-with-streams.html.html) en la guía para desarrolladores Amazon Kinesis.
Los siguientes ejemplos muestran cómo:
+ Cree una secuencia de datos mediante [CreateAlias](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#createstream).
+ Obtenga información detallada acerca de una sola secuencia de datos por medio de [DescribeStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#describestream).
+ Enumere las secuencias de datos con [ListStreams](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#liststreams).
+ Envíe datos a una secuencia de datos existente mediante [PutRecord](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#putrecord).
+ Elimine una secuencia de datos mediante [DeleteStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#deletestream).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de la guía para desarrolladores, consulte [la guía para desarrolladores Amazon Kinesis Data](https://docs.aws.amazon.com/kinesis/latest/dev/).
## Crear un flujo de datos utilizando un flujo de datos de Kinesis
Establezca un flujo de datos de Kinesis en la que pueda enviar información que procesará Kinesis mediante el siguiente ejemplo de código. Obtenga más información sobre [cómo crear y actualizar flujos de datos](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) en la Guía para desarrolladores de Amazon Kinesis.
Para crear una secuencia de datos de Kinesis, utilice la operación [CreateStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Recuperación de un flujo de datos
Obtenga información detallada acerca de una secuencia de datos existente mediante el siguiente ejemplo de código. De forma predeterminada, este devuelve información acerca de las primeras 10 particiones conectadas al flujo de datos de Kinesis especificado. Recuerde comprobar `StreamStatus` desde la respuesta antes de escribir datos en un flujo de datos de Kinesis.
Para recuperar los detalles acerca de una secuencia de datos de Kinesis especificada, utilice la operación [DescribeStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Lista de flujos de datos existentes que están conectados a Kinesis
Enumere los primeros 10 flujos de datos desde su cuenta de Cuenta de AWS en la región de AWS seleccionada. Utilice el ``HasMoreStreams` devuelto para determinar si hay más secuencias asociadas a su cuenta.
Para obtener una lista de los flujos de datos de Kinesis, utilice la operación [ListStreams](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Envío de datos a un flujo de datos existente
Una vez que haya creado una secuencia de datos, utilice el siguiente ejemplo para enviar datos. Antes de enviarle los datos, utilice `DescribeStream` para comprobar si los datos `StreamStatus` están activos.
Para escribir un único registro de datos en un flujo de datos de Kinesis, utilice la operación [PutRecord](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html). Para escribir hasta 500 registros en un flujo de datos de Kinesis, utilice la operación [PutRecord](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de un flujo de datos
En este ejemplo se muestra cómo se elimina una secuencia de datos. Eliminar una secuencia de datos, también elimina todos los datos que haya enviado a la secuencia de datos. Los flujos de datos de Kinesis activos cambian al estado ELIMINANDO hasta que se haya completado la secuencia de eliminación. Mientras se encuentra en el estado ELIMINANDO, la secuencia sigue procesando datos.
Para eliminar un flujo de datos de Kinesis, utilice la operación [DeleteStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Administrar fragmentos de datos mediante la API de flujos de datos de Kinesis y la versión 3 de AWS SDK para PHP
Amazon Kinesis Data Streams le permite enviar datos en tiempo real a un punto de enlace. La velocidad del flujo de datos depende del número de fragmentos de la secuencia.
Puede escribir 1000 registros por segundo en un único fragmento. Cada fragmento también tiene un límite de carga de 1 MiB por segundo. El uso se calcula y se cobra por fragmento, así que debe usar estos ejemplos para administrar la capacidad de los datos y el costo de la secuencia.
Los siguientes ejemplos muestran cómo:
+ Enumere los fragmentos de una secuencia con [ListShards](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#listshards).
+ Añada o reduzca el número de fragmentos de una secuencia usando [UpdateShardCount](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-kinesis-1913-12-02.html#updateshardcount).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon Kinesis Data Streams, consulte la [guía para desarrolladores Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/).
## Lista de fragmentos de secuencias de datos
Enumere los detalles de hasta 100 fragmentos de una secuencia específica.
Para enumerar los fragmentos de un flujo de datos de Kinesis, utilice la operación [ListShards](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Añadir más fragmentos de secuencias de datos
Si necesita más fragmentos de secuencias de datos, puede aumentar su número actual de fragmentos. Le recomendamos que duplique el recuento de fragmentos cuando aumente. Esto crea una copia de cada partición disponible actualmente para aumentar la capacidad. Puede duplicar el número de los fragmentos solo dos veces en un periodo de 24 horas.
Recuerde que la facturación por el uso de Kinesis Data Streams se calcula por fragmento, de manera que cuando la demanda disminuye, le recomendamos que reduzca el número de fragmentos a la mitad. Al eliminar los fragmentos, solo puede reducir la cantidad de fragmentos a la mitad de su recuento de fragmentos actual.
Para actualizar el recuento de fragmentos de un flujo de datos de Kinesis, utilice la operación [UpdateShardCount](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_UpdateShardCount.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Creación de flujos de entrega mediante la API de Firehose y la versión 3 de AWS SDK para PHP
Amazon Data Firehose le permite enviar datos en tiempo real a otros servicios de AWS, como Amazon Kinesis Data Streams, Amazon S3, Amazon OpenSearch Service (OpenSearch Service) y Amazon Redshift o a Splunk. Cree un productor de datos con secuencias de entrega que entregue datos al destino configurado cada vez que agregue datos.
Los siguientes ejemplos muestran cómo:
+ Cree una secuencia de entrega con [CreateDeliveryStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#createdeliverystream).
+ Obtenga información detallada acerca de una sola secuencia de entrega por medio de [DescribeDeliveryStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#describedeliverystream).
+ Enumere las secuencias de entrega mediante [ListDeliveryStreams](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#listdeliverystreams).
+ Envíe datos a una secuencia de entrega con [PutRecord](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#putrecord).
+ Elimine una secuencia de entrega con [DeleteDeliveryStream](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-firehose-2015-08-04.html#deletedeliverystream).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información acerca del uso de Amazon Data Firehose, consulte la [Guía para desarrolladores de Amazon Kinesis Data Firehose](https://docs.aws.amazon.com/streams/latest/dev/).
## Crear un flujo de entrega utilizando un flujo de datos Kinesis
Para establecer un flujo de entrega que introduzca datos en un flujo de datos de Kinesis existente, utilice la operación [CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html).
Esto permite a los desarrolladores migrar los servicios Kinesis existentes a Firehose.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Crear un flujo de entrega utilizando un bucket de Amazon S3
Para establecer un flujo de entrega que coloque datos en un bucket de Amazon S3 existente, utilice la operación [CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html).
Proporcione los parámetros del destino, tal y como se describe en [Parámetros de destino](https://docs.aws.amazon.com/firehose/latest/dev/create-destination.html). A continuación, asegúrese de conceder a Firehose acceso al bucket de Amazon S3, tal y como se describe en [Concesión a Kinesis Data Firehose de acceso a un destino de Amazon S3](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Crear un flujo de entrega utilizando OpenSearch Service
Para establecer un flujo de entrega que coloque datos en un clúster de OpenSearch Service, utilice la operación [CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html).
Proporcione los parámetros del destino, tal y como se describe en [Parámetros de destino](https://docs.aws.amazon.com/firehose/latest/dev/create-destination.html). Asegúrese de conceder acceso a Firehose al clúster de OpenSearch Service, como se describe en [Concesión a Kinesis Data Firehose de acceso a un destino de Amazon ES](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-es.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Recuperar un flujo de entrega
Para obtener los detalles sobre un flujo de entrega de Firehose existente, utilice la operación [DescribeDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DescribeDeliveryStream.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Lista de flujos de entrega existentes conectados a Kinesis Data Streams
Para enumerar todas las secuencias de entrega de Firehose existentes que envían datos a Kinesis Data Streams, utilice la operación [ListDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Lista de flujos de entrega existentes que envían datos a otros servicios de AWS
Para enumerar todos los flujos de entrega de Firehose existentes que envían datos a Amazon S3, OpenSearch Service o Amazon Redshift, o a Splunk, utilice la operación [ListDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Envío de datos a un flujo de entrega de Firehose existente
Para enviar datos a través de un flujo de entrega de Firehose al destino especificado, utilice la operación [PutRecord](https://docs.aws.amazon.com/firehose/latest/APIReference/API_API_PutRecord.html) después de crear un flujo de entrega de Firehose.
Antes de enviar datos a un flujo de entrega de Firehose, utilice `DescribeDeliveryStream` para ver si el flujo de entrega está activo.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de un flujo de entrega de Firehose
Para eliminar un flujo de entrega de Firehose, utilice la operación [DeleteDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeleteDeliveryStreams.html). Esta operación también elimina todos los datos que haya enviado a la secuencia de entrega.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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 ejemplos que utilizan la AWS SDK para PHP versión 3
AWS Elemental MediaConvert es un servicio de transcodificación de vídeo basado en archivos con funciones aptas para la radiodifusión. Puede usarlo para crear recursos para su emisión y entrega video-on-demand (VOD) a través de Internet. Para obtener más información, consulte la [Guía del usuario de AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/).
La API de PHP para AWS Elemental MediaConvert se expone a través de la clase de *`AWS.MediaConvert`*cliente. Para obtener más información, consulte [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) en la referencia de la API.
## Cree y gestione trabajos de transcodificación en AWS Elemental MediaConvert
En este ejemplo, utiliza la AWS SDK para PHP versión 3 para llamar AWS Elemental MediaConvert y crear un trabajo de transcodificación. Antes de comenzar, debe cargar el vídeo de entrada en el bucket de Amazon S3 habilitado para el almacenamiento de entrada. Para obtener una lista de los códecs y contenedores compatibles con la entrada de vídeo, consulte[Códecs y contenedores de entrada compatibles](https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html) [AWS Elemental MediaConvert Guía del usuario.](https://docs.aws.amazon.com/mediaconvert/latest/ug/).
Los siguientes ejemplos muestran cómo:
+ Cree trabajos de transcodificación en. AWS Elemental MediaConvert[CreateJob](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#createjob).
+ Cancela un trabajo de transcodificación de la AWS Elemental MediaConvert cola. [CancelJob](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#canceljob)
+ Recupera el JSON para completar un trabajo de transcodificación. [GetJob](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#getjob)
+ Recupere una matriz JSON para un máximo de 20 de los trabajos creados más recientemente. [ListJobs](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-mediaconvert-2017-08-29.html#listjobs)
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
### Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para acceder al MediaConvert cliente, cree un rol de IAM que dé AWS Elemental MediaConvert acceso a sus archivos de entrada y a los buckets de Amazon S3 donde se almacenan los archivos de salida. Para obtener más información, consulte [Configurar los permisos de IAM](https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html) in the [AWS Elemental MediaConvert Guía del usuario](https://docs.aws.amazon.com/mediaconvert/latest/ug/).
### Crear un cliente
Para AWS SDK para PHP configurarlo, cree un MediaConvert cliente con la región de su código. En este ejemplo, la región se establece en us-west-2.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\MediaConvert\MediaConvertClient;
```
**Código de muestra**
```
$mediaConvertClient = new MediaConvertClient([
'version' => '2017-08-29',
'region' => 'us-east-2',
'profile' => 'default'
]);
```
### Definición de un trabajo de transcodificación sencillo
Cree el JSON que define los parámetros del trabajo de transcodificación.
Estos parámetros son detallados. Puede utilizar la [consola de AWS Elemental MediaConvert](https://console.aws.amazon.com/mediaconvert/home) para generar los parámetros JSON del trabajo eligiendo la configuración del trabajo en la consola y, a continuación, eligiendo **Mostrar JSON del trabajo** en la parte inferior de la sección **Trabajo**. En este ejemplo, se muestra el JSON de un trabajo sencillo.
**Código de muestra**
```
$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"
]
];
```
### Creación de un trabajo
Después de crear el JSON con los parámetros del trabajo, llame al método createJob invocando un `AWS.MediaConvert service object` y pasando los parámetros. El ID del trabajo creado se devuelve en los datos de la respuesta.
**Código de muestra**
```
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";
}
```
### Recuperación de un trabajo
Con el JobID que se devuelve al llamar a createjob, se pueden obtener descripciones detalladas de los trabajos recientes en formato JSON.
**Código de muestra**
```
$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";
}
```
### Cancelación de un trabajo
Con el JobID que se devuelve al llamar a createjob, se puede cancelar un trabajo mientras esté en la cola. No se pueden cancelar los trabajos cuya transcodificación ya ha comenzado.
**Código de muestra**
```
$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";
}
```
### Listado de los trabajos de transcodificación recientes
Cree el JSON con los parámetros, incluidos los valores que especifican si se debe ordenar la lista en orden ascendente (ASCENDING) o descendente (DESCENDING), el ARN de la cola de trabajos que se va comprobar y el estado de los trabajos que se deben incluir. Esto devuelve hasta 20 trabajos. Para recuperar los siguientes 20 trabajos más recientes, utilice la cadena nextToken devuelta con el resultado.
**Código de muestra**
```
$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";
}
```
# Ejemplos de Amazon S3 con la AWS SDK para PHP versión 3
Amazon Simple Storage Service (Amazon S3) es un servicio web que proporciona almacenamiento en la nube con una alto grado de escalabilidad. Amazon S3 ofrece almacenamiento de objetos fácil de usar con una sencilla interfaz de servicios web que puede utilizarse para almacenar y recuperar la cantidad de datos que desee, cuando desee y desde cualquier lugar de la web.
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
**Topics**
+ [Credenciales](#examplecredentials)
+ [Creación y uso de buckets de Amazon S3](s3-examples-creating-buckets.md)
+ [Administración de permisos de acceso a los buckets de Amazon S3](s3-examples-access-permissions.md)
+ [Configuración de los buckets de Amazon S3](s3-examples-configuring-a-bucket.md)
+ [Cargas multiparte de Amazon S3](s3-multipart-upload.md)
+ [URL prefirmada de Amazon S3](s3-presigned-url.md)
+ [Creación de POST prefirmados S3](s3-presigned-post.md)
+ [Uso de un bucket de Amazon S3 como host web estático](s3-examples-static-web-host.md)
+ [Uso de políticas de bucket de Amazon S3](s3-examples-bucket-policies.md)
+ [Uso de ARN de punto de acceso de S3](s3-examples-access-point-arn.md)
+ [Uso de puntos de acceso multirregionales](s3-multi-region-access-points.md)
# Creación y utilización de buckets de Amazon S3 con la versión 3 de AWS SDK para PHP
Los siguientes ejemplos muestran cómo:
+ Obtener una lista de los buckets pertenecientes al remitente autenticado de la solicitud utilizando [ListBuckets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#listbuckets).
+ Crear un nuevo bucket utilizando [CreateBucket](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#createbucket).
+ Añadir un objeto a un bucket utilizando [PutObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\S3\S3Client;
```
## Obtener una lista de buckets
Cree un archivo PHP con el siguiente código. En primer lugar, cree un servicio cliente AWS.S3 que especifique la región de AWS y la versión. A continuación, llame al método `listBuckets`, que devuelve todos los buckets de Amazon S3 que pertenecen al remitente de la solicitud como una matriz de estructuras Bucket.
**Código de muestra**
```
$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";
}
```
## Crear un bucket
Cree un archivo PHP con el siguiente código. En primer lugar, cree un servicio cliente AWS.S3 que especifique la región de AWS y la versión. Llame entonces al método `createBucket` con una matriz como parámetro. El único campo obligatorio es la clave 'Bucket', con un valor de cadena para el nombre del bucket que desea crear. Sin embargo, puede especificar también la región de AWS con el campo "CreateBucketConfiguration". Si se ejecuta correctamente, este método devuelve la ubicación del bucket.
**Código de muestra**
```
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();
```
## Colocar un objeto en un bucket
Para añadir archivos a su nuevo bucket, cree un archivo PHP con el código siguiente.
Ejecute este archivo en la línea de comandos y especificando una cadena con el nombre del bucket en el que desea cargar su archivo, seguido de la ruta completa del archivo que desea cargar.
**Código de muestra**
```
$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";
}
```
# Administración de permisos de acceso a los buckets de Amazon S3 con la versión 3 de AWS SDK para PHP
Las listas de control de acceso (ACL) son una de las opciones de política de acceso basada en recursos que puede utilizar para administrar el acceso a sus buckets y objetos. Puede utilizar las ACL para otorgar permisos básicos de lectura o escritura a otras cuentas de AWS. Para obtener más información, consulte [Administración de acceso con ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
El siguiente ejemplo muestra cómo:
+ Obtener la política de control de acceso para un bucket utilizando [GetBucketAcl](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketacl).
+ Establecer los permisos en un bucket con ACL utilizando [PutBucketAcl](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketacl).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Obtener y establecer una política de lista de control de acceso
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\S3\S3Client;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
// 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";
}
```
# Configuración de los buckets de Amazon S3 con la versión 3 de AWS SDK para PHP
El uso compartido de recursos entre orígenes (CORS) define una manera para que las aplicaciones web de los clientes cargadas en un dominio interactúen con los recursos de un dominio diferente. Gracias a la compatibilidad con CORS en Amazon S3, puede desarrollar aplicaciones web del lado del cliente completas con Amazon S3 y permitir el acceso entre orígenes a sus recursos de Amazon S3 de forma selectiva.
Para obtener más información sobre el uso de la configuración CORS con un bucket de Amazon S3, consulte [Uso compartido de recursos entre orígenes (CORS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html).
Los siguientes ejemplos muestran cómo:
+ Obtener la configuración CORS para un bucket utilizando [GetBucketCors](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketcors).
+ Establecer la configuración CORS para un bucket utilizando [PutBucketCors](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketcors).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Obtener la configuración CORS
Cree un archivo PHP con el siguiente código. En primer lugar, cree un servicio de cliente AWS.S3, luego llame al método `getBucketCors` y especifique el bucket cuya configuración CORS desea.
El único parámetro necesario es el nombre del bucket seleccionado. Si el bucket tiene actualmente una configuración CORS, Amazon S3 devuelve dicha configuración como [objeto CORSRules](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#shape-corsrule).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**Código de muestra**
```
$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());
}
```
## Establecer la configuración CORS
Cree un archivo PHP con el siguiente código. En primer lugar, cree un servicio de cliente de AWS.S3. A continuación, llame al método `putBucketCors` y especifique el bucket cuya configuración CORS desea establecer y la CORSConfiguration como [objeto JSON CORSRules](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#shape-corsrule).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**Código de muestra**
```
$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());
}
```
# Uso de cargas multiparte de Amazon S3 con AWS SDK para PHP la versión 3
Puede cargar objetos de hasta 5 GB en una única operación `PutObject`. Sin embargo, si utiliza los métodos de carga multiparte (por ejemplo, `CreateMultipartUpload`, `UploadPart`, `CompleteMultipartUpload`, `AbortMultipartUpload`), podrá cargar objetos de entre 5 MB y 5 TB.
El siguiente ejemplo muestra cómo:
+ Cargue un objeto en Amazon S3 mediante [ObjectUploader](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.ObjectUploader.html).
+ Cree una carga multiparte para un objeto de Amazon S3 mediante [MultipartUploader](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.MultipartUploader.html).
+ Copie objetos de una ubicación de Amazon S3 a otra utilizando [ObjectCopier](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.ObjectCopier.html).
Todo el código de ejemplo para el AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Cargador de objetos
Si no está seguro de si `PutObject` o `MultipartUploader` es mejor opción para la tarea, utilice `ObjectUploader`. `ObjectUploader` carga un archivo de gran tamaño en Amazon S3 utilizando `PutObject` o `MultipartUploader`, en función del tamaño de la carga útil.
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\ObjectUploader;
use Aws\S3\S3Client;
```
**Código de muestra**
```
// 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);
```
### Configuración
El constructor del objeto `ObjectUploader` acepta los siguientes argumentos:
**`$client`**
Es el objeto `Aws\ClientInterface` que hay que utilizar para ejecutar las transferencias. Debería ser una instancia de `Aws\S3\S3Client`.
**`$bucket`**
(`string`, *obligatorio*) Es el nombre del bucket al que se está cargando el objeto.
**`$key`**
(`string`, *obligatorio*) Es la clave que se utiliza para el objeto que se está cargando.
**`$body`**
(`mixed`, *obligatorio*) Datos del objeto que se van a cargar. Puede ser un `StreamInterface`, un recurso de flujo de PH, o una cadena de datos a cargar.
**`$acl`**
(`string`) Es la lista de control de acceso (ACL) para establecer el objeto que se carga. De forma predeterminada, los objetos son privados.
**`$options`**
Es una matriz asociativa de opciones de configuración para la carga multiparte. Las siguientes opciones de configuración son válidas:
**`add_content_md5`**
(`bool`) Configúrelo en true para calcular automáticamente la MD5 suma de verificación de la carga.
**`mup_threshold`**
(`int`, *predeterminado*:`int(16777216)`) El número de bytes del tamaño del archivo. Si el tamaño del archivo supera este límite, se utiliza una carga multiparte.
**`before_complete`**
(`callable`) Es la devolución de llamada a invocar antes de la operación `CompleteMultipartUpload`. La devolución de llamada debe tener una firma de función similar a: `function (Aws\Command $command) {...}`. Consulta la [referencia de la CompleteMultipartUpload API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#completemultipartupload) para ver los parámetros que puedes añadir al `CommandInterface` objeto.
**`before_initiate`**
(`callable`) Es la devolución de llamada a invocar antes de la operación `CreateMultipartUpload`. La devolución de llamada debe tener una firma de función similar a: `function (Aws\Command $command) {...}`. El SDK invoca esta devolución de llamada si el tamaño del archivo supera el valor de `mup_threshold`. Consulta la [referencia de la CreateMultipartUpload API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#createmultipartupload) para ver los parámetros que puedes añadir al `CommandInterface` objeto.
**`before_upload`**
(`callable`) Es la devolución de llamada a invocar antes de cualquier operación `PutObject` o `UploadPart`. La devolución de llamada debe tener una firma de función similar a: `function (Aws\Command $command) {...}`. El SDK invoca esta devolución de llamada si el tamaño del archivo es igual o mayor que el valor de `mup_threshold`. Consulta la [referencia de la PutObject API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject) para ver los parámetros que puedes aplicar a la `PutObject` solicitud. Para ver los parámetros que se aplican a una `UploadPart` solicitud, consulta la [referencia de la UploadPart API](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#uploadpart). El SDK ignora cualquier parámetro que no sea aplicable a la operación representada por el objeto `CommandInterface`.
**`concurrency`**
(`int`, *predeterminado*: `int(3)`) Es el número máximo de operaciones `UploadPart` simultáneas permitido durante la carga multiparte.
**`part_size`**
(`int`, *predeterminado*: `int(5242880)`) Es el tamaño de la parte, en bytes, que se debe utilizar al realizar una carga multiparte. El valor debe estar comprendido entre 5 MB y 5 GB, ambos incluidos.
**`state`**
(`Aws\Multipart\UploadState`) Es un objeto que representa el estado de la carga multiparte y que se utiliza para reanudar una carga previa. Si se proporciona esta opción, se ignoran los argumentos `$bucket` y `$key` arguments y la opción `part_size`.
**`params`**
Una matriz asociativa que proporciona opciones de configuración para cada subcomando. Por ejemplo:
```
new ObjectUploader($bucket, $key, $body, $acl, ['params' => ['CacheControl' => ])
```
## MultipartUploader
Las cargas multiparte están diseñadas para mejorar la experiencia de carga de los objetos más grandes. Estas permiten cargar objetos en partes independientes, en cualquier orden y en paralelo.
Se recomienda a los clientes de Amazon S3 que utilicen cargas multiparte para objetos de más de 100 MB.
## MultipartUploader objeto
El SDK tiene un objeto `MultipartUploader` especial que simplifica el proceso de carga multiparte.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Código de muestra**
```
$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";
}
```
El cargador crea un generador de datos de la parte, en función del origen que se haya proporcionado y de la configuración, e intenta cargar todas las partes. Si falla la carga de algunas partes, el cargador continúa cargando otras partes hasta que se haya leído todo el origen de datos. A continuación, el cargador vuelve a intentar cargar las partes que han dado error o genera una excepción que contiene información acerca de las partes que no se han podido cargar.
## Personalización de una carga multiparte
Puede configurar las opciones personalizadas en las operaciones `CreateMultipartUpload`, `UploadPart` y `CompleteMultipartUpload` ejecutadas por el cargador multiparte mediante devoluciones de llamada transferidas a su constructor.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Código de muestra**
```
// 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';
},
]);
```
### Recopilación manual de elementos no utilizados entre cargas de partes
Si se alcanza el límite de memoria al realizar cargas de gran tamaño, puede deberse a las referencias cíclicas generadas por el SDK que el [recolector de elementos no utilizados de PHP](https://www.php.net/manual/en/features.gc.php) todavía no había recopilado cuando se alcanzó el límite de memoria. Si se invoca manualmente el algoritmo de recopilación entre las operaciones, es posible que los ciclos se recopilen antes de alcanzar dicho límite. En el siguiente ejemplo, se invoca el algoritmo de recopilación mediante una devolución de llamada antes de la carga de cada parte. Tenga en cuenta que invocar el recolector de elementos no utilizados conlleva un costo de rendimiento y su uso óptimo dependerá de su caso de uso y su entorno.
```
$uploader = new MultipartUploader($client, $source, [
'bucket' => 'your-bucket',
'key' => 'your-key',
'before_upload' => function(\Aws\Command $command) {
gc_collect_cycles();
}
]);
```
## Recuperación tras sufrir errores
Cuando se produce un error durante el proceso de carga multiparte, se lanza una excepción `MultipartUploadException`. Esta excepción proporciona acceso al objeto `UploadState`, que contiene información sobre el progreso de la carga multiparte. El objeto `UploadState` puede utilizarse para reanudar una carga que no se ha completado.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Código de muestra**
```
// 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);
}
```
Si se reanuda una carga a partir de un objeto `UploadState`, se intenta cargar las partes que todavía no se han cargado. El objeto de estado realiza un seguimiento de las partes que faltan, aunque no sean consecutivas. El cargador lee o busca en el archivo de origen facilitado los rangos de bytes que pertenecen a las partes que todavía deben cargarse.
Los objetos `UploadState` se pueden serializar, por lo que también puede reanudar una carga en un proceso diferente. También puede obtener el objeto `UploadState`, incluso si no gestiona una excepción, llamando a `$uploader->getState()`.
**importante**
Los flujos que se transfieren como un origen a un `MultipartUploader` no se rebobinan automáticamente antes de cargarlos. Si utiliza un flujo en lugar de una ruta de archivo en un bucle similar al del ejemplo anterior, restablezca la variable `$source` dentro del bloque `catch`.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Código de muestra**
```
// 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);
```
### Anulación de la carga multiparte
Una carga multiparte se puede anular al recuperar el `UploadId` que se encuentra en el objeto `UploadState` y transferirlo a `abortMultipartUpload`.
```
try {
$result = $uploader->upload();
} catch (MultipartUploadException $e) {
// State contains the "Bucket", "Key", and "UploadId"
$params = $e->getState()->getId();
$result = $s3Client->abortMultipartUpload($params);
}
```
## Cargas multiparte asíncronas
Llamar a `upload()` en el `MultipartUploader` es una solicitud de bloqueo. Si está trabajando en un contexto asíncrono, puede obtener una [promesa](guide_promises.md) para la carga multiparte.
```
require 'vendor/autoload.php';
use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
```
**Código de muestra**
```
// 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();
```
### Configuración
El constructor del objeto `MultipartUploader` acepta los siguientes argumentos:
** `$client` **
Es el objeto `Aws\ClientInterface` que hay que utilizar para ejecutar las transferencias. Debería ser una instancia de `Aws\S3\S3Client`.
** `$source` **
Son los datos de origen que se están cargando. Esto puede ser una ruta o una URL (por ejemplo, `/path/to/file.jpg`), un controlador de recursos (por ejemplo, `fopen('/path/to/file.jpg', 'r)`) o una instancia de un [flujo PSR-7](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Psr.Http.Message.StreamInterface.html).
** `$config` **
Es una matriz asociativa de opciones de configuración para la carga multiparte.
Las siguientes opciones de configuración son válidas:
** `acl` **
(`string`) Es la lista de control de acceso (ACL) para establecer el objeto que se carga. De forma predeterminada, los objetos son privados.
** `before_complete` **
(`callable`) Es la devolución de llamada a invocar antes de la operación `CompleteMultipartUpload`. La devolución de llamada debería tener una firma de la función del tipo `function (Aws\Command $command) {...}`.
** `before_initiate` **
(`callable`) Es la devolución de llamada a invocar antes de la operación `CreateMultipartUpload`. La devolución de llamada debería tener una firma de la función del tipo `function (Aws\Command $command) {...}`.
** `before_upload` **
(`callable`) Es la devolución de llamada a invocar antes de cualquier operación `UploadPart`. La devolución de llamada debería tener una firma de la función del tipo `function (Aws\Command $command) {...}`.
** `bucket` **
(`string`, *obligatorio*) Es el nombre del bucket al que se está cargando el objeto.
** `concurrency` **
(`int`, *predeterminado*: `int(5)`) Es el número máximo de operaciones `UploadPart` simultáneas permitido durante la carga multiparte.
** `key` **
(`string`, *obligatorio*) Es la clave que se utiliza para el objeto que se está cargando.
** `part_size` **
(`int`, *predeterminado*: `int(5242880)`) Es el tamaño de la parte, en bytes, que se debe utilizar al realizar una carga multiparte. Debe ser de entre 5 MB y 5 GB, ambos incluidos.
** `state` **
(`Aws\Multipart\UploadState`) Es un objeto que representa el estado de la carga multiparte y que se utiliza para reanudar una carga previa. Si se proporciona esta opción, se omiten las opciones `bucket`, `key` y `part_size`.
**`add_content_md5`**
(`boolean`) Configúrelo en true para calcular automáticamente la MD5 suma de verificación de la carga.
**`params`**
Una matriz asociativa que proporciona opciones de configuración para cada subcomando. Por ejemplo:
```
new MultipartUploader($client, $source, ['params' => ['CacheControl' => ]])
```
## Copias multiparte
AWS SDK para PHP También incluye un `MultipartCopy` objeto que se utiliza de forma similar al`MultipartUploader`, pero que está diseñado para copiar objetos de entre 5 GB y 5 TB de tamaño en Amazon S3.
```
require 'vendor/autoload.php';
use Aws\Exception\MultipartUploadException;
use Aws\S3\MultipartCopy;
use Aws\S3\S3Client;
```
**Código de muestra**
```
// 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 prefirmada de Amazon S3 con la AWS SDK para PHP versión 3
Puede autenticar determinados tipos de solicitudes pasando la información requerida como parámetros de una cadena de consulta, en lugar de usar el encabezado de autorización HTTP. Esto resulta útil para permitir el acceso directo de navegadores de terceros a sus datos de Amazon S3 privados, sin enviar la solicitud por proxy. La idea es construir una solicitud “prefirmada” y codificarla como una URL que pueda utilizar otro usuario. Además, puede limitar una solicitud prefirmada especificando una fecha de vencimiento.
## Creación de una URL prefirmada para una solicitud GET de HTTP
En el siguiente ejemplo de código se muestra cómo crear una URL prefirmada para una solicitud GET de HTTP mediante el SDK para 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;
```
En la [referencia de la API para el método `createPresignedRequest`](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.S3Client.html#method_createPresignedRequest) se proporcionan más detalles.
Otra persona puede utilizar el valor `$presignedUrl` para recuperar el objeto en la próxima hora. Cuando se realiza la solicitud GET de HTTP (por ejemplo, mediante un navegador), el servicio S3 considera que la llamada proviene del usuario que ha creado la URL prefirmada.
## Creación de una URL prefirmada para una solicitud PUT de HTTP
En el siguiente ejemplo de código se muestra cómo crear una URL prefirmada para una solicitud PUT de HTTP mediante el SDK para 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();
```
Otro usuario ahora puede utilizar la URL prefirmada en una solicitud PUT de HTTP para cargar un archivo:
```
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;
}
}
```
# POST prefirmados de Amazon S3 con la versión 3 de AWS SDK para PHP
Al igual que las URL prefirmadas, los POST prefirmados permiten dar acceso de escritura a un usuario sin proporcionarle credenciales de AWS. Los formularios POST prefirmados se pueden crear con la ayuda de una instancia de [AwsS3PostObjectV4](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.PostObjectV4.html).
Los siguientes ejemplos muestran cómo:
+ Obtener datos para un formulario de carga POST de objetos de S3 con [PostObjectV4](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.S3.PostObjectV4.html).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
**nota**
`PostObjectV4` no funciona con credenciales procedentes de AWS IAM Identity Center.
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Creación de PostObjectV4
Para crear una instancia de `PostObjectV4`, debe proporcionar lo siguiente:
+ Instancia de `Aws\S3\S3Client`
+ bucket
+ matriz asociativa de campos de entrada de formularios
+ conjunto de condiciones de política (consulte [Construcción de políticas](https://docs.aws.amazon.com/AmazonS3/latest/dev/HTTPPOSTForms.html) en la Guía del usuario de Amazon Simple Storage Service)
+ cadena de fecha de vencimiento para la política (opcional, una hora de forma predeterminada).
**Importaciones**
```
require '../vendor/autoload.php';
use Aws\S3\PostObjectV4;
use Aws\S3\S3Client;
```
**Código de muestra**
```
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
```
# Uso de un bucket de Amazon S3 como host web estático con la versión 3 de AWS SDK para PHP
Puede alojar un sitio web estático en Amazon S3. Para obtener más información, consulte [Alojamiento de un sitio web estático en Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
El siguiente ejemplo muestra cómo:
+ Obtener la configuración de sitio web para un bucket con [GetBucketWebsite](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketwebsite).
+ Establecer la configuración de sitio web para un bucket con [PutBucketWebsite](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketwebsite).
+ Eliminar la configuración de sitio web para un bucket con [DeleteBucketWebsite](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#deletebucketwebsite).
Todo el código de ejemplo de la versión 3 de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS. Consulte [Credenciales para la versión 3 de AWS SDK para PHP](guide_credentials.md).
## Obtener, establecer y eliminar la configuración de sitio web para un bucket
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**Código de muestra**
```
$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";
}
```
# Uso de las políticas de los buckets de Amazon S3 con la versión 3 de AWS SDK para PHP
Puede utilizar una política de bucket para conceder permisos a sus recursos de Amazon S3. Para obtener más información, consulte [Uso de políticas de bucket y usuario](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
El siguiente ejemplo muestra cómo:
+ Devolver la política a un bucket determinado utilizando [GetBucketPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketpolicy).
+ Sustituir una política en un bucket utilizando [PutBucketPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putbucketpolicy).
+ Eliminar una política de un bucket utilizando [DeleteBucketPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#deletebucketpolicy).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Obtener, eliminar y sustituir una política en un bucket
**Importaciones**
```
require "vendor/autoload.php";
use Aws\Exception\AwsException;
use Aws\S3\S3Client;
```
**Código de muestra**
```
$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";
}
```
# Uso de los ARN de punto de acceso S3 en la versión 3 de AWS SDK para PHP
S3 introdujo los puntos de acceso, una nueva forma de interactuar con los buckets de S3. Los puntos de acceso pueden tener políticas y configuraciones únicas aplicadas a ellos en lugar de directamente al bucket. AWS SDK para PHP le permite utilizar ARN de punto de acceso en el campo del bucket para operaciones de la API en lugar de especificar explícitamente el nombre del bucket. Puede encontrar más información sobre cómo funcionan los ARN y los puntos de acceso S3 [aquí](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html). Los siguientes ejemplos muestran cómo:
+ Utilice [GetObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getobject) con un ARN de punto de acceso para obtener un objeto de un bucket.
+ Utilice [PutObject](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject) con un ARN de punto de acceso para agregar un objeto a un bucket.
+ Configure el cliente de S3 para que utilice la región ARN en lugar de la región de cliente.
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\S3\S3Client;
```
## Get Object
En primer lugar, cree un servicio cliente AWS.S3 que especifique la región de AWS y la versión. Luego llame al método `getObject` con su clave y un ARN de punto de acceso de S3 en el campo `Bucket`, que obtendrá el objeto del bucket asociado con ese punto de acceso.
**Código de muestra**
```
$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'
]);
```
## Colocar un objeto en un bucket
En primer lugar, cree un servicio cliente AWS.S3 que especifique la región de AWS y la versión. A continuación, llame al método `putObject` con la clave, el cuerpo o el archivo de origen deseados y un ARN de punto de acceso de S3 en el campo `Bucket`, que colocará el objeto en el bucket asociado con ese punto de acceso.
**Código de muestra**
```
$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'
]);
```
## Configure el cliente de S3 para que utilice la región ARN en lugar de la región de cliente
Cuando se utiliza un ARN de punto de acceso de S3 en una operación de cliente de S3, de forma predeterminada el cliente se asegurará de que la región ARN coincida con la región de cliente, produciendo una excepción si no lo hace. Este comportamiento se puede cambiar para aceptar la región ARN por delante de la región de cliente estableciendo la opción de configuración `use_arn_region` en `true`. De forma predeterminada, la opción se establece en `false`.
**Código de muestra**
```
$s3 = new S3Client([
'version' => 'latest',
'region' => 'us-west-2',
'use_arn_region' => true
]);
```
El cliente también comprobará una variable de entorno y una opción de archivo de configuración, en el siguiente orden de prioridad:
1. La opción de cliente `use_arn_region`, como en el ejemplo anterior.
1. La variable de entorno de la `AWS_S3_USE_ARN_REGION`
```
export AWS_S3_USE_ARN_REGION=true
```
1. La variable de configuración `s3_use_arn_region` en el archivo de configuración compartida de AWS (de forma predeterminada en `~/.aws/config`).
```
[default]
s3_use_arn_region = true
```
# Utilice los puntos de acceso multirregionales de Amazon S3 con la AWS SDK para PHP versión 3
Los [puntos de acceso multirregionales de Amazon Simple Storage Service (S3)](https://docs.aws.amazon.com//AmazonS3/latest/userguide/MultiRegionAccessPoints.html) proporcionan un punto de conexión global para enrutar el tráfico de solicitudes de Amazon S3 entre Regiones de AWS.
Puede crear puntos de acceso multirregionales [mediante el SDK for PHP](https://docs.aws.amazon.com//aws-sdk-php/v3/api/api-s3control-2018-08-20.html#createmultiregionaccesspoint), otro AWS SDK, la [consola S3 o la AWS CLI,](https://docs.aws.amazon.com//AmazonS3/latest/userguide/multi-region-access-point-create-examples.html)
**importante**
Para usar puntos de acceso multirregionales con el SDK para PHP, su entorno PHP debe tener instalada la [extensión AWS Common Runtime (AWS CRT)](guide_crt.md).
Cuando crea un punto de acceso multirregional, Amazon S3 genera un nombre de recurso de Amazon (ARN) con el siguiente formato:
`arn:aws:s3::account-id:accesspoint/MultiRegionAccessPoint_alias`
Puede utilizar el ARN generado en lugar del nombre del bucket para los métodos `[getObject()](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getobject)` y `[putObject()](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject)`.
```
'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";
```
# Administración de secretos mediante la API Secrets Manager y la versión 3 de AWS SDK para PHP
AWS Secrets Manager almacena y administra secretos compartidos como, por ejemplo, contraseñas, claves de API y credenciales de bases de datos. Con el servicio Secrets Manager, los desarrolladores pueden sustituir credenciales con codificación rígida en el código implementado por una llamada integrada a Secrets Manager.
Secrets Manager admite de forma nativa la rotación automática y programada de credenciales para bases de datos de Amazon Relational Database Service (Amazon RDS), lo que aumenta la seguridad de las aplicaciones. Secrets Manager también puede rotar sin problemas los secretos de otras bases de datos y servicios de terceros mediante AWS Lambda para implementar detalles específicos del servicio.
Los siguientes ejemplos muestran cómo:
+ Crear un secreto con [CreateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#createsecret).
+ Recuperar un secreto con [GetSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#getsecretvalue).
+ Obtener una lista de todos los secretos almacenados por Secrets Manager con [ListSecrets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#listsecrets).
+ Obtener información detallada acerca de un secreto determinado con [DescribeSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#describesecret).
+ Actualizar un secreto determinado con [PutSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#putsecretvalue).
+ Configurar una rotación de secretos con [RotateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret).
+ Marcar un secreto para eliminarlo con [DeleteSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#deletesecret).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Crear un secreto en Secrets Manager
Para crear un secreto en Secrets Manager, utilice la operación [CreateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#createsecret).
En este ejemplo, un nombre de usuario y una contraseña se almacenan en una cadena JSON.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Recuperar un secreto de Secrets Manager
Para recuperar el valor de un secreto almacenado en Secrets Manager, utilice la operación [GetSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#getsecretvalue).
En este ejemplo, `secret` es una cadena que contiene el valor almacenado. Si el valor de `username` es `<>` y el valor de `password` es `<>`, la salida de `secret` es:
```
{"username":"<>","password":"<>"}
```
Utilice `json_decode($secret, true)` para acceder a los valores de la matriz.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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;
```
## Mostrar los secretos almacenados en Secrets Manager
Puede obtener una lista de todos los secretos almacenados en Secrets Manager mediante la operación [ListSecrets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#listsecrets).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Recuperar los detalles de un secreto
Los secretos almacenados contienen metadatos sobre las reglas de rotación, la fecha en que se modificaron o se tuvo acceso a ellos por última vez, las etiquetas creadas por el usuario y el nombre de recurso de Amazon (ARN). Para obtener los detalles de un secreto determinado almacenado en Secrets Manager, utilice la operación [DescribeSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#describesecret).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Actualización del valor del secreto
Para almacenar el valor de un secreto nuevo cifrado en Secrets Manager, utilice la operación [PutSecretValue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#putsecretvalue).
De esta forma, se crea una versión nueva del secreto. Si ya existe una versión del secreto, añada el parámetro `VersionStages` con el valor existente en `AWSCURRENT` para asegurarse de que se utiliza el valor nuevo al recuperar el valor.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Rotar el valor de un secreto existente en Secrets Manager
Para rotar el valor de un secreto existente almacenado en Secrets Manager, utilice una función de rotación de Lambda y la operación [RotateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret).
Antes de comenzar, cree una función de Lambda para rotar el secreto. El [catálogo de ejemplos de código de AWS](https://docs.aws.amazon.com/code-samples/latest/catalog/code-catalog-lambda_functions-secretsmanager.html) contiene varios ejemplos de código de Lambda para la rotación de credenciales de base de datos de Amazon RDS.
**nota**
Para obtener más información acerca de la rotación de secretos, consulte [Rotación de sus secretos de AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) en la Guía del usuario de AWS Secrets Manager.
Después de configurar la función de Lambda, configure una rotación de secretos nueva.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
Cuando configure una rotación, puede implementar una rotación utilizando la operación [RotateSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#rotatesecret).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminar un secreto de Secrets Manager
Para eliminar un secreto determinado de Secrets Manager, utilice la operación [DeleteSecret](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-secretsmanager-2017-10-17.html#deletesecret). Para evitar la eliminación accidental de un secreto, se añade automáticamente una marca DeletionDate al secreto que especifica un intervalo de tiempo de recuperación en el que puede deshacer la eliminación. Si no se especifica la fecha para el intervalo de recuperación, el periodo de tiempo predeterminado es de 30 días.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\SecretsManager\SecretsManagerClient;
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Información relacionada
Los ejemplos de AWS SDK para PHP utilizan las siguientes operaciones REST de la Referecia de la API de AWS Secrets Manager:
+ [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)
Para obtener más información acerca de cómo usar AWS Secrets Manager, consulte la [Guía del usuario de AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/).
# Ejemplos de Amazon SES con la versión 3 de AWS SDK para PHP
Amazon Simple Email Service (Amazon SES) es una plataforma de correo electrónico que ofrece un método sencillo y rentable de enviar y recibir correo electrónico a través de los propios dominios y direcciones de correo electrónico. Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
AWS ofrece dos versiones del servicio Amazon SES y, en consecuencia, el SDK para PHP ofrece dos versiones del cliente: [SESClient](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Ses.SesClient.html) y [SESV2Client](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.SesV2.SesV2Client.html). Las funcionalidades de los clientes se superponen en muchos casos, aunque la forma en que se llama a los métodos o los resultados pueden diferir. Las dos API también ofrecen funciones exclusivas, por lo que puede utilizar ambos clientes para acceder a todas las funciones.
En los ejemplos de esta sección se utiliza `SesClient`.
Todo el código de ejemplo de la versión 3 de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Verificación de direcciones de correo electrónico](ses-verify.md)
+ [Uso de plantillas de correo electrónico](ses-template.md)
+ [Administración de filtros de correo electrónico](ses-filters.md)
+ [Uso de reglas de correo electrónico](ses-rules.md)
+ [Monitorización de la actividad de envío](ses-send-email.md)
+ [Autorización de remitentes](ses-sender-policy.md)
# Verificación de identidades de correo electrónico mediante la API de Amazon SES y la versión 3 de AWS SDK para PHP
La primera vez que se utiliza la cuenta de Amazon Simple Email Service (Amazon SES), todos los remitentes y destinatarios deben verificarse en la misma región de AWS a la que se envían los mensajes de correo electrónico. Para obtener más información sobre el envío de mensajes de correo electrónico, consulte [Envío de correo electrónico con Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-email.html).
Los siguientes ejemplos muestran cómo:
+ Verifique una dirección de correo electrónico utilizando [VerifyEmailIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifyemailidentity).
+ Verifique un dominio de correo electrónico utilizando [VerifyDomainIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifydomainidentity).
+ Enumere todas las direcciones de correo electrónico mediante [ListIdentities](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities).
+ Enumere todos los dominios de correo electrónico mediante [ListIdentities](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities).
+ Elimine una dirección de correo electrónico utilizando [DeleteIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity).
+ Elimine un dominio de correo electrónico utilizando [DeleteIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Verificar una dirección de correo electrónico
Amazon SES solo puede enviar correos electrónicos desde direcciones de correo electrónico o dominios verificados. Al verificar una dirección de correo electrónico, demuestra que es el propietario de esa dirección y que desea permitir que Amazon SES envíe mensajes de correo electrónico desde esa dirección.
Al ejecutar el siguiente ejemplo de código, Amazon SES envía un mensaje de correo electrónico a la dirección especificada. Cuando usted (o el destinatario del mensaje de correo electrónico) hagan clic en el enlace del mensaje, la dirección se habrá verificado.
Para añadir una dirección de correo electrónico a su cuenta de Amazon SES, utilice la operación [VerifyEmailIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyEmailIdentity.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Verificar un dominio de correo electrónico
Amazon SES solo puede enviar correos electrónicos desde direcciones de correo electrónico o dominios verificados. Al verificar un dominio, demuestra que es el propietario de ese dominio. Si verifica un dominio, permite a Amazon SES enviar correo electrónico desde cualquier dirección de correo electrónico de dicho dominio.
Cuando ejecute el siguiente ejemplo de código, Amazon SES le proporcionará un token de verificación. Debe añadir el token a la configuración de DNS del dominio. Para obtener más información, consulte [Verificación de un dominio con Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html) en la Guía para desarrolladores de Amazon Simple Email Service.
Para añadir un dominio de envío a su cuenta de Amazon SES, utilice la operación [VerifyDomainIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyDomainIdentity.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Lista de direcciones de correo electrónico
Para recuperar una lista de direcciones de correo electrónico enviadas en la región de AWS actual, independientemente del estado de verificación, utilice la operación [ListIdentities](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Lista de dominios de correo electrónico
Para recuperar una lista de dominios de correo electrónico enviada a la región de AWS actual, independientemente del estado de verificación, utilice la operación [ListIdentities](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de una dirección de correo electrónico
Para eliminar una dirección de correo electrónico verificada en la lista de identidades, utilice la operación [DeleteIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de un dominio de correo electrónico
Para eliminar un dominio de correo electrónico verificado de la lista de identidades verificadas, utilice la operación [DeleteIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Creación de plantillas de correo electrónico personalizadas mediante la API de Amazon SES y la versión 3 de AWS SDK para PHP
Amazon Simple Email Service (Amazon SES) ermite enviar mensajes de correo electrónico personalizados para cada destinatario mediante el uso de plantilla Las plantillas incluyen una línea de asunto y las partes de texto y HTML del cuerpo del correo electrónico. Las secciones de asunto y cuerpo también pueden contener valores únicos personalizados para cada destinatario.
Para obtener más información, consulte [Envío de correo electrónico personalizado mediante Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) en la guía para desarrolladores de Amazon Simple Email Service.
Los siguientes ejemplos muestran cómo:
+ Crear una plantilla de correo electrónico mediante [CreateTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createtemplate).
+ Enumerar de todas las plantillas de correo electrónico mediante [ListTemplates](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listtemplates).
+ Recuperar una plantilla de correo electrónico mediante [GetTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#gettemplate).
+ Actualizar una plantilla de correo electrónico mediante [UpdateTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updateTemplate).
+ Quitar una plantilla de correo electrónico mediante [DeleteTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletetemplate).
+ Enviar un mensaje de correo electrónico con una plantilla mediante [SendTemplatedEmail](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#sendtemplatedemail).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Creación de una plantilla de correo electrónico
Para crear una plantilla para enviar mensajes de correo electrónico personalizados, utilice la operación [CreateTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateTemplate.html). La plantilla la puede utilizar cualquier cuenta autorizada a enviar mensajes en la región de AWS a la que la plantilla se añada.
**nota**
Amazon SES no valida su HTML, por lo que debe asegurarse de que *HtmlPart* sea válido antes de enviar un mensaje de correo electrónico.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Obtener una plantilla de correo electrónico
Para ver el contenido de una plantilla de correo electrónico existente incluida la línea de asunto, el cuerpo en HTML y el texto sin formato, utilice la operación [GetTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetTemplate.html). Solo es obligatorio el campo TemplateName.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Enumerar todas las plantillas de correo electrónico
Para recuperar una lista de todas las plantillas de correo electrónico que estén asociadas a su Cuenta de AWS en la región de AWS actual, utilice la operación [ListTemplates](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListTemplates.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Actualización de una plantilla de correo electrónico
Para cambiar el contenido de una plantilla de correo electrónico específica incluida la línea de asunto, el cuerpo en HTML y el texto sin formato, utilice la operación [UpdateTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdadteTemplate.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de una plantilla de correo electrónico
Para eliminar una plantilla de correo electrónico específica, utilice la operación [DeleteTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteTemplate.html). Solo se requiere TemplateName.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Enviar un mensaje de correo electrónico con una plantilla
Para usar una plantilla para enviar un mensaje de correo electrónico a los destinatarios, utilice la operación [SendTemplatedEmail](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Administración de filtros de correo electrónico mediante la API de Amazon SES y la versión 3 de AWS SDK para PHP
Además de enviar correos electrónicos, también puede recibirlos con Amazon Simple Email Service (Amazon SES). Un filtro de direcciones IP le permite especificar opcionalmente si desea aceptar o rechazar el correo que procede de una dirección IP o de un intervalo de direcciones IP. Para obtener más información, consulte [Administración de filtros de direcciones IP para recepción de correo electrónico de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html).
Los siguientes ejemplos muestran cómo:
+ Cree un filtro de correo electrónico con [CreateReceiptFilter](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptfilter).
+ Obtenga una lista de todos los filtros de correo electrónico mediante [ListReceiptFilters](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptfilters).
+ Elimine un filtro de correo electrónico con [DeleteReceiptFilter](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptfilter).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Creación de un filtro de correo electrónico
Para permitir o bloquear mensajes de correo electrónico desde una dirección IP específica, utilice la operación [CreateReceiptFilter](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptFilter.html). Proporcione la dirección o el rango de direcciones IP y un nombre único para identificar este filtro.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Enumerar todos los filtros de correo electrónico
Para obtener una lista de los filtros de dirección IP asociados a su Cuenta de AWS en la región de AWS actual, utilice la operación [ListReceiptFilters](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptFilters.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de un filtro de correo electrónico
Para eliminar un filtro existente para una dirección IP específica, use la operación [DeleteReceiptFilter](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptFilter.html). Proporcione el nombre del filtro único para identificar el filtro de recepción que desea eliminar.
Si necesita cambiar el rango de direcciones que se filtran, puede eliminar una filtro de recepción y crear uno nuevo.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Creación y administración de reglass de correo electrónico mediante la API de Amazon SES y la versión 3 de AWS SDK para PHP
Además de enviar correos electrónicos, también puede recibirlos con Amazon Simple Email Service (Amazon SES). Las reglas de recepción le permiten especificar qué hace Amazon SES con el correo electrónico que reciba para las direcciones de correo electrónico o dominios de su propiedad. Una regla puede enviar correo electrónico a otros servicios de AWS incluidos con carácter meramente enunciativo, Amazon S3, Amazon SNS o AWS Lambda.
Para obtener más información, consulte la sección [Administración de conjuntos de reglas de recepción para recepción de correo electrónico de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) y [Administración de reglas de recepción para recepción de correo electrónico de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html).
Los siguientes ejemplos muestran cómo:
+ Cree un conjunto de reglas de recepción mediante [CreateReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptruleset).
+ Cree una regla de recepción mediante [CreateReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptrule).
+ Describa un conjunto de reglas de recepción mediante [DescribeReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptruleset).
+ Describa una regla de recepción mediante [DescribeReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptrule).
+ Enumere todos los conjuntos de reglas de recepción mediante [ListReceiptRuleSets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptrulesets).
+ Actualice un conjunto de reglas de recepción mediante [UpdateReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updatereceiptrule).
+ Elimine un conjunto de reglas de recepción mediante [DeleteReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptrule).
+ Elimine un conjunto de reglas de recepción mediante [DeleteReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptruleset).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Creación de un conjunto de reglas de recepción
Un conjunto de reglas de recepción contiene una colección de reglas de recepción. Debe tener al menos un conjunto de reglas de recepción asociadas a su cuenta para poder crear una regla de recepción. Para crear un conjunto de reglas de recepción, indique un valor único de RuleSetName y use la operación [CreateReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRuleSet.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Creación de una regla de recepción
Controle el correo electrónico entrante añadiendo una regla de recepción a un conjunto de reglas de recepción existente. En este ejemplo se muestra cómo crear una regla de recepción que envía los mensajes entrantes a un bucket de Amazon S3, pero también se pueden enviar mensajes a Amazon SNS y AWS Lambda. Para crear una regla de recepción, proporcione una regla y el valor de RuleSetName en la operación [CreateReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Descripción de un conjunto de reglas de recepción
Una vez por cada segundo, devuelva los detalles del conjunto de reglas de recepción especificado. Para utilizar la operación [DescribeReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRuleSet.html), proporcione el valor de RuleSetName.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Descripción de una regla de recepción
Devuelva los detalles de una regla de recepción especificada. Para utilizar la operación [DescribeReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRule.html), proporcione el valor de RuleName y RuleSetName.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Enumeración de todos los conjuntos de reglas de recepción
Para enumerar los conjuntos de reglas de recepción que existen en la región de Cuenta de AWS actual, AWS utilice la operación [ListReceiptRuleSets](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptRuleSets.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Actualización de una regla de recepción
En este ejemplo se muestra cómo actualizar una regla de recepción que envía mensajes entrantes a una función de AWS Lambda, pero también puede enviar mensajes a Amazon SNS y Amazon S3. Para usar la operación [UpdateReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateReceiptRule.html), proporcione la nueva regla de recepción y el valor de RuleSetName.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de un conjunto de reglas de recepción
Elimine un determinado conjunto de reglas de recepción que no esté deshabilitado actualmente. Esta acción también elimina todas las reglas de recepción que contiene. Para crear un conjunto de reglas de recepción, proporcione el valor de RuleSetName en la operación [DeleteReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRuleSet.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
## Eliminación de una regla de recepción
Para crear una regla de recepción determinada, proporcione el valor de RuleName y RuleSetName en la operación [DeleteReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRule.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
```
**Código de muestra**
```
$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";
}
```
# Monitorización de la actividad de envío mediante la API de Amazon SES y la versión 3 de AWS SDK para PHP
Amazon Simple Email Service (Amazon SES) ofrece métodos para monitorizar su actividad de envío. Le recomendamos que implemente estos métodos para que pueda realizar un seguimiento de medidas importantes, como, por ejemplo, las tasas de rebotes, reclamaciones y rechazos de su cuenta. Unas tasas de rebotes y reclamaciones excesivamente altas pueden poner en peligro su capacidad para enviar correos electrónicos utilizando Amazon SES.
Los siguientes ejemplos muestran cómo:
+ Comprobar su cuota de envío con [GetSendQuota](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendquota).
+ Monitorizar su actividad de envío con [GetSendStatistics](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendstatistics).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Comprobar su cuota de envío
Tiene un límite de enviar solo una cantidad determinada de mensajes en un único periodo de 24 horas. Para comprobar la cantidad de mensajes que aún puede enviar, utilice la operación [GetSendQuota](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendQuota.html). Para obtener más información, consulte [Administrar sus límites de envío de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Código de muestra**
```
$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";
}
```
## Monitorización de la actividad de envío
Para recuperar métricas de mensajes que haya enviado en las últimas dos semanas, utilice la operación [GetSendStatistics](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendStatistics.html). En este ejemplo, se devuelve el número de intentos de entrega, rebotes, reclamaciones y mensajes rechazados en incrementos de 15 minutos.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Código de muestra**
```
$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";
}
```
# Autorización de remitentes mediante la API de Amazon SES y la versión 3 de AWS SDK para PHP
Para permitir que otra Cuenta de AWS, usuario de AWS Identity and Access Management user, o servicio de AWS envíe mensajes de correo electrónico a través de Amazon Simple Email Service (Amazon SES) en su nombre, debe crear una política de autorización de envío. Se trata de un documento JSON que se asocia a una identidad de su propiedad.
La política enumera de forma expresa a quién permite enviar para dicha identidad y en qué condiciones. No se permite enviar mensajes de correo electrónico a todos los remitentes excepto usted y las entidades a las que conceda permiso explícitamente en la política. Una identidad puede no tener ninguna política, una política o varias políticas asociadas. También puede tener una política con varias instrucciones para conseguir el efecto de varias políticas.
Para obtener más información, consulte [Using Sending Authorization with Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
Los siguientes ejemplos muestran cómo:
+ Cree un remitente autorizado mediante [PutIdentityPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createidentitypolicy).
+ Recupere políticas para un remitente autorizado mediante [GetIdentityPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getidentitypolicies).
+ Enumere los remitentes autorizados mediante [ListIdentityPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentitypolicies).
+ Revoque el permiso para un remitente autorizado mediante [DeleteIdentityPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentitypolicy).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
Para obtener más información sobre el uso de Amazon SES, consulte la [Guía para desarrolladores de Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/).
## Creación de un remitente autorizado
Para autorizar a otra cuenta de Cuenta de AWS para enviar mensajes de correo electrónico en su nombre, utilice una política de identidad para añadir o actualizar la autorización para enviar mensajes de correo electrónico desde sus direcciones de correo electrónico verificadas o dominios. Para crear una política de identidad, utilice la operación [PutIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_PutIdentityPolicy.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Código de muestra**
```
$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";
}
```
## Recuperación de políticas para un remitente autorizado
Devuelva las políticas de autorización de envío que estén asociadas a una identidad de correo electrónico o de dominio específicas. Para obtener la autorización de envío para una determinada dirección de correo electrónico o dominio, utilice la operación [GetIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetIdentityPolicy.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Código de muestra**
```
$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";
}
```
## Lista de remitentes autorizados
Para enumerar las políticas de autorización de envío que estén asociadas a una identidad de correo electrónico o de dominio específicas en la región de AWS actual, utilice la operación [ListIdentityPolicies](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentityPolicies.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Código de muestra**
```
$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";
}
```
## Revocación del permiso para un remitente autorizado
Para eliminar la autorización de envío de otra Cuenta de AWS para enviar mensajes de correo electrónico con una identidad de correo electrónico o de dominio eliminando la política de identidad asociada con la operación [DeleteIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentityPolicy.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Ses\SesClient;
```
**Código de muestra**
```
$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";
}
```
# Ejemplos de Amazon SNS con la versión 3 AWS SDK para PHP
Amazon Simple Notification Service (Amazon SNS) es un servicio web que coordina y gestiona la entrega o el envío de mensajes a los puntos de conexión o clientes suscritos.
En Amazon SNS, existen dos tipos de clientes: los editores (también conocidos como productores) y los suscriptores (también conocidos como consumidores). Los publicadores se comunican de forma asíncrona con los suscriptores generando y enviando un mensaje a un tema, que es un punto de acceso lógico y un canal de comunicación. Los suscriptores (servidores web, direcciones de correo electrónico, colas de Amazon SQS, AWS Lambda funciones) consumen o reciben el mensaje o la notificación a través de uno de los protocolos compatibles (Amazon SQS, HTTP/HTTPS URLs correo electrónico, AWS SMS Lambda) cuando se suscriben al tema.
[Todo el código de ejemplo de la AWS SDK para PHP versión 3 está disponible aquí. GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code)
**Topics**
+ [Administración de temas](sns-examples-managing-topics.md)
+ [Administración de suscripciones](sns-examples-subscribing-unsubscribing-topics.md)
+ [Envío de mensajes SMS en Amazon](sns-examples-sending-sms.md)
# Administración de temas en Amazon SNS con la versión 3 de AWS SDK para PHP
Para enviar notificaciones a Amazon Simple Queue Service (Amazon SQS), URL HTTP/HTTPS, correo electrónico, AWS SMS, o AWS Lambda, primero debe crear un tema que administre la entrega de los mensajes a los suscriptores de ese tema
En lo relativo al patrón de diseño de observador, un tema es como el asunto. Una vez que se crea un tema, se añaden los suscriptores que reciben notificaciones automáticas cuando se publica un mensaje en el tema.
Obtenga más información sobre la suscripción a temas en [Administración de suscripciones en Amazon SNS con la versión 3 de AWS SDK para PHP](sns-examples-subscribing-unsubscribing-topics.md).
Los siguientes ejemplos muestran cómo:
+ Crear un tema en el que publicar notificaciones mediante [CreateTopic](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#createtopic).
+ Devolver una lista de los temas del solicitante con [ListTopics](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listtopic).
+ Eliminar un tema y todas sus suscripciones con [DeleteTopic](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#deletetopic).
+ Devolver todas las propiedades de un tema con [GetTopicAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#gettopicattributes).
+ Permitir a un propietario de tema establecer un atributo del tema en un nuevo valor mediante [SetTopicAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#settopicattributes).
Para obtener más información sobre el uso de Amazon SNS, consulte [Atributos de temas de Amazon SNS para el estado de entrega de mensajes](https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Crear un tema
Para crear un tema, utilice la operación [CreateTopic](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html).
Cada nombre de tema de su Cuenta de AWS debe ser exclusivo.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Lista de temas
Para obtener una lista de hasta 100 temas existentes en la región de AWS actual, utilice la operación [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminación de un tema
Para quitar un tema existente y todas sus suscripciones, utilice la operación [DeleteTopic](https://docs.aws.amazon.com/sns/latest/api/API_DeleteTopic.html).
Todos los mensajes que no se han entregado a los suscriptores también se eliminarán.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Obtener de atributos de los temas
Para recuperar las propiedades de un solo tema existente, utilice la operación [GetTopicAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetTopicAttributes.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Crear atributos de temas
Para actualizar las propiedades de un solo tema existente, utilice la operación [SetTopicAttributes](https://docs.aws.amazon.com/sns/latest/api/API_SetTopicAttributes.html).
Solo puede establecer los atributos `Policy`, `DisplayName` y `DeliveryPolicy`.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
# Administración de suscripciones en Amazon SNS con AWS SDK para PHP la versión 3
Utilice los temas del Servicio de Notificación de Amazon Simple (Amazon SNS) para enviar notificaciones a Amazon Simple Queue Service (Amazon SQS), HTTP/HTTPS, direcciones de correo electrónico, () o. AWS Server Migration Service AWS SMS AWS Lambda
Las suscripciones se adjuntan a un tema que administra el envío de mensajes a los suscriptores. Obtenga más información sobre la creación de temas en [Administrar temas en Amazon SNS con la AWS SDK para PHP versión 3](sns-examples-managing-topics.md).
Los siguientes ejemplos muestran cómo:
+ Suscribirse a un tema existente mediante [Subscribe](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#subscribe).
+ Verifique una suscripción mediante [ConfirmSubscription](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#confirmsubscription).
+ Enumere las suscripciones existentes utilizando [ListSubscriptionsByTopic](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listsubscriptionsbytopic).
+ Eliminar una suscripción mediante [Unsubscribe](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#unsubscribe).
+ Enviar un mensaje a todos los suscriptores de un tema, mediante [Publish](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#publish).
Para obtener más información sobre el uso de Amazon SNS, consulte [Uso de Amazon System-to-System SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-system-to-system-messaging.html) para mensajería.
Todos los códigos de ejemplo para el AWS SDK para PHP están disponibles [aquí en. GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code)
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus AWS credenciales, tal y como se describe en[Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe las AWS SDK para PHP, tal y como se describe en[Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Suscribir una dirección de correo electrónico a un tema
Para iniciar una suscripción a una dirección de correo electrónico, utilice la operación [Suscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Puede utilizar el método de suscripción para suscribir a varios puntos de conexión diferentes a un tema de Amazon SNS, en función de los valores utilizados para los parámetros pasados. Esto se muestra en otros ejemplos en este tema.
En este ejemplo, el punto de enlace es una dirección de correo electrónico. Se envía un token de confirmación a este correo electrónico. Compruebe la suscripción con este token de confirmación en un plazo de tres días desde la recepción.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Suscripción de un punto de conexión de aplicación a un tema
Para iniciar una suscripción a una aplicación web, utilice la operación [Suscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Puede utilizar el método de suscripción para suscribirse a varios puntos de conexión diferentes a un tema de Amazon SNS, en función de los valores utilizados para los parámetros pasados. Esto se muestra en otros ejemplos en este tema.
En este ejemplo, el punto de enlace es una URL. Se envía un token de confirmación a esta dirección web. Compruebe la suscripción con este token de confirmación en un plazo de tres días desde la recepción.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Suscripción de una función de Lambda a un tema
Para iniciar una suscripción a una función de Lambda, utilice la operación [Suscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Puede utilizar el método de suscripción para suscribirse a varios puntos de conexión diferentes a un tema de Amazon SNS, en función de los valores utilizados para los parámetros pasados. Esto se muestra en otros ejemplos en este tema.
En este ejemplo, el punto de conexión es una función de Lambda. Se envía un token de confirmación a esta función de Lambda. Compruebe la suscripción con este token de confirmación en un plazo de tres días desde la recepción.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Suscripción de un mensaje SMS a un tema
Para enviar mensajes SMS a varios números de teléfono al mismo tiempo, suscriba cada número a un tema.
Para iniciar una suscripción a un número de teléfono, utilice la operación [Suscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html).
Puede utilizar el método de suscripción para suscribirse a varios puntos de conexión diferentes a un tema de Amazon SNS, en función de los valores utilizados para los parámetros pasados. Esto se muestra en otros ejemplos en este tema.
En este ejemplo, el punto de enlace es un número de teléfono en formato E.164, un estándar utilizado para las telecomunicaciones internacionales.
Se envía un token de confirmación a este número de teléfono. Compruebe la suscripción con este token de confirmación en un plazo de tres días desde la recepción.
Para una conocer una manera alternativa de enviar mensajes SMS con Amazon SNS, consulte [Envío de mensajes SMS en Amazon SNS con la versión 3 de AWS SDK para PHP](sns-examples-sending-sms.md).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Confirmación de la suscripción a un tema
Para crear una suscripción real, el propietario del punto de enlace debe reconocer la intención de recibir mensajes del tema utilizando un token enviado cuando se establece inicialmente una suscripción, tal y como se ha descrito anteriormente. Los tokens de confirmación son válidos durante tres días. Después de tres días, puede volver a enviar un token mediante la creación de una nueva suscripción.
Para confirmar una suscripción, utilice la [ConfirmSubscription](https://docs.aws.amazon.com/sns/latest/api/API_ConfirmSubscription.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Lista de suscripciones a un tema
Para enumerar hasta 100 suscripciones existentes en una AWS región determinada, utilice la [ListSubscriptions](https://docs.aws.amazon.com/sns/latest/api/API_ListSubscriptions.html)operación.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Cancelación de la suscripción a un tema
Para eliminar un punto de enlace suscrito a un tema, utilice la operación [Unsubscribe](https://docs.aws.amazon.com/sns/latest/api/API_Unsubscribe.html).
Si la suscripción requiere autenticación para eliminarla, solo el propietario de la suscripción o el propietario del tema pueden cancelar la suscripción y se requiere una AWS firma. Si la llamada de cancelación de suscripción no requiere autenticación y el solicitante no es el propietario de la suscripción, se envía un último mensaje de cancelación al punto de enlace.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Publicación de mensajes en un tema de Amazon SNS
Para entregar un mensaje a cada punto de conexión que está suscrito a un tema de Amazon SNS, utilice la operación [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
Cree un objeto que contenga los parámetros para la publicación de un mensaje, incluido el texto del mensaje y el nombre de recurso de Amazon (ARN) del tema de Amazon SNS.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
# Envío de mensajes SMS en Amazon SNS con la versión 3 de AWS SDK para PHP
Puede utilizar Amazon Simple Notification Service (Amazon SNS) ara enviar mensajes de texto o mensajes SMS a dispositivos habilitados para recibir SMS. Dispone de la capacidad de enviar un mensaje directamente a un número de teléfono o de enviar un mensaje a varios números de teléfono a la vez suscribiendo dichos números de teléfono a un tema y enviando su mensaje al tema.
Utilice Amazon SNS para especificar las preferencias de mensajería SMS, como la forma en que se optimizan sus envíos (por coste o por fiabilidad de la entrega), su límite de gasto mensual, cómo se registran los envíos de mensajes y si desea suscribirse a informes de uso de SMS diarios. Estas preferencias se recuperan y se establecen como atributos SMS para Amazon SNS.
Cuando envíe un mensaje SMS, especifique el número de teléfono usando la formato E.164. E.164 es un estándar de estructura de número de teléfono utilizada para las telecomunicaciones internacionales. Los números de teléfono que aplican este formato pueden tener un máximo de 15 dígitos y van prefijados con el carácter (\$1) y el código de país. Por ejemplo, un número de teléfono de los EE. UU. en formato E.164 se mostraría como \$11001XXX5550100.
Los siguientes ejemplos muestran cómo:
+ Recupere la configuración predeterminada para el envío de mensajes SMS desde su cuenta con [GetSMSAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#getsmsattributes).
+ Actualice la configuración predeterminada para el envío de mensajes SMS desde su cuenta con [SetSMSAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#setsmsattributes).
+ Descubra si un determinado propietario de número de teléfono ha desactivado la recepción de mensajes SMS desde su cuenta con [CheckIfPhoneNumberISOptedOut](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#checkifphonenumberisoptedout).
+ Obtener una lista de los números de teléfono cuyo propietario ha desactivado la recepción de mensajes SMS desde su cuenta con [ListPhoneNumberOptedOut](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#listphonenumbersoptedout).
+ Envíe un mensaje de texto (mensaje SMS) directamente a un número de teléfono usando [Publish](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#publish).
Para obtener más información sobre cómo utilizar Amazon SNS, consulte [Uso de Amazon SNS para notificaciones de usuario con un número de teléfono móvil como suscriptor (envío de SMS).](https://docs.aws.amazon.com/sns/latest/dg/sns-mobile-phone-number-as-subscriber.html).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Obtención de atributos de SMS
Para recuperar la configuración predeterminada de mensajes SMS, utilice la operación [GetSMSAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSMSAttributes.html).
Este ejemplo obtiene el atributo `DefaultSMSType`. Este atributo controla si se envían mensajes SMS como `Promotional`, que optimiza la entrega de mensajes para conseguir el costo más bajo, o como `Transactional`, que optimiza el envío de mensajes para conseguir la máxima fiabilidad.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Establecimiento de atributos de SMS
Para actualizar la configuración predeterminada de mensajes SMS, utilice la operación [SetSMSAttributes](https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html).
Este ejemplo establece el atributo `DefaultSMSType` en `Transactional`, que optimiza el envío de mensajes para conseguir la máxima fiabilidad.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Comprobación de si se ha desactivado un número de teléfono
Para determinar si un propietario de número de teléfono concreto ha desactivado la recepción de mensajes SMS desde su cuenta, use la operación [CheckIfPhoneNumberIsOptedOut](https://docs.aws.amazon.com/sns/latest/api/API_CheckIfPhoneNumberIsOptedOut.html).
En este ejemplo, el número de teléfono está en formato E.164, un estándar utilizado para las telecomunicaciones internacionales.
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Lista de números de teléfono desactivados
Para recuperar una lista de números de teléfono en los que el propietario haya desactivado la recepción de mensajes SMS desde su cuenta, utilice la operación [ListPhoneNumbersOptedOut](https://docs.aws.amazon.com/sns/latest/api/API_ListPhoneNumbersOptedOut.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
## Publicación en un mensaje de texto (mensaje SMS)
Para entregar un mensaje de texto (mensaje SMS) directamente a un número de teléfono, utilice la operación [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
En este ejemplo, el número de teléfono está en formato E.164, un estándar utilizado para las telecomunicaciones internacionales.
Los mensajes SMS puede contener hasta 140 bytes. El límite de tamaño de una sola acción de publicación SMS es de 1600 bytes.
Para obtener más información sobre cómo enviar mensajes SMS, consulte [Envío de un mensaje SMS](https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html).
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;
```
**Código de muestra**
```
$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());
}
```
# Ejemplos de Amazon SQS con la versión 3 de AWS SDK para PHP
Amazon Simple Queue Service (SQS) es un servicio de colas de mensajes rápido, de confianza, escalable y totalmente administrado. Amazon SQS permite desacoplar componentes de una aplicación en la nube. Amazon SQS incluye colas estándar con un alto rendimiento y procesamiento al menos una vez, y colas FIFO que ofrecen distribución FIFO (primero en entrar, (primero en entrar, primero en salir) primero en salir) y procesamiento exactamente una vez.
Todo el código de ejemplo de la versión 3 de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
**Topics**
+ [Habilitación del sondeo largo](sqs-examples-enable-long-polling.md)
+ [Administración del tiempo de espera de visibilidad](sqs-examples-managing-visibility-timeout.md)
+ [Envío y recepción de mensajes](sqs-examples-send-receive-messages.md)
+ [Uso de colas de mensajes fallidos de](sqs-examples-dead-letter-queues.md)
+ [Uso de colas](sqs-examples-using-queues.md)
# Habilitación del sondeo largo en Amazon SQS con la versión 3 de AWS SDK para PHP
El sondeo largo reduce el número de respuestas vacías al permitir que Amazon SQS espere un tiempo determinado a que haya un mensaje disponible en la cola antes de enviar una respuesta. Asimismo, el sondeo largo elimina las respuestas vacías falsas, ya que consulta todos los servidores en lugar de solo una muestra de servidores. Para habilitar el sondeo largo, especifique un tiempo de espera diferente de cero para los mensajes recibidos. Para obtener más información, consulte [Sondeo largo de Amazon SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html).
Los siguientes ejemplos muestran cómo:
+ Establecer atributos en una cola de Amazon SQS para habilitar el sondeo largo utilizando [SetQueueAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#setqueueattributes).
+ Recuperar uno o varios mensajes con sondeo largo utilizando [ReceiveMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#receivemessage).
+ Crear una cola de sondeo largo utilizando [CreateQueue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#createqueue).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Establecer atributos en una cola para habilitar el sondeo largo
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
## Recuperar mensajes con el sondeo largo
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
## Crear una cola con el sondeo largo
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
# Administración del tiempo de espera de visibilidad en Amazon SQS con la versión 3 de AWS SDK para PHP
Un tiempo de espera de visibilidad es un intervalo durante el cual Amazon SQS impide que otros componentes consumidores reciban y procesen un mensaje. Para obtener más información, consulte [Tiempo de espera de visibilidad](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html).
El siguiente ejemplo muestra cómo:
+ Para cambiar el tiempo de espera de visibilidad de mensajes determinados en una cola definiendo nuevos valores, use [ChangeMessageVisibilityBatch](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#changemessagevisibilitybatch).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Cambiar el tiempo de espera de visibilidad de varios mensajes
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
# Envío y recepción de mensajes en Amazon SQS con la versión 3 de AWS SDK para PHP
Para obtener información sobre los mensajes de Amazon SQS, consulte [Envío de un mensaje a una cola de SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-send-message.html) y [ecepción y eliminación de un mensaje de una cola de SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-receive-delete-message.html.html) en la Guía del usuario de Service Quotas.
Los siguientes ejemplos muestran cómo:
+ Entregar un mensaje en una cola especificada con [SendMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#sendmessage).
+ Recuperar uno o varios mensajes (hasta 10) de una cola especificada con [ReceiveMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#receivemessage).
+ Eliminar un mensaje de una cola con [DeleteMessage](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#deletemessage).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Enviar un mensaje
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
## Recibir y eliminar mensajes
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
# Uso de colas de mensajes fallidos en Amazon SQS con la versión 3 de AWS SDK para PHP
Una cola de mensajes fallidos es una cola a la que otras colas (de origen) pueden enviar mensajes que no se han podido procesar correctamente. Puede apartar y aislar estos mensajes en la cola de mensajes fallidos para determinar por qué no se procesaron correctamente. Debe configurar individualmente cada cola de origen que envía mensajes a una cola de mensajes fallidos. Varias colas pueden dirigirse a una única cola de mensajes fallidos.
Para obtener más información, consulte [Uso de colas de mensajes fallidos de SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html).
El siguiente ejemplo muestra cómo:
+ Habilitar una cola de mensajes fallidos utilizando [SetQueueAttributes](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#setqueueattributes).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Habilitar una cola de mensajes fallidos
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
# Uso de colas en Amazon SQS con la versión 3 de AWS SDK para PHP
Para obtener más información sobre las colas de Amazon SQS [Funcionamiento de colas SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-how-it-works.html).
Los siguientes ejemplos muestran cómo:
+ Devolver una lista de sus colas utilizando [ListQueues](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#listqueues).
+ Crear una nueva cola utilizando [CreateQueue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#createqueue).
+ Devolver la URL de una cola existente utilizando [GetQueueUrl](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#getqueueurl).
+ Eliminar una cola especificada utilizando [DeleteQueue](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sqs-2012-11-05.html#deletequeue).
Todo el código de ejemplo de AWS SDK para PHP está disponible [aquí en GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code).
## Credenciales
Antes de ejecutar el código de ejemplo, configure sus credenciales de AWS, como se indica en [Autenticación AWS con la AWS SDK para PHP versión 3](credentials.md). A continuación, importe AWS SDK para PHP, como se indica en [Instalación de la AWS SDK para PHP versión 3](getting-started_installation.md).
## Devolver una lista de colas
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
## Creación de una cola
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
## Devolver la URL de una cola
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
## Eliminar una cola
**Importaciones**
```
require 'vendor/autoload.php';
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
```
**Código de muestra**
```
$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());
}
```
# Envía eventos a los puntos finales EventBridge globales de Amazon con la AWS SDK para PHP versión 3
Puede utilizar los [puntos de enlace EventBridge globales de Amazon](https://docs.aws.amazon.com//eventbridge/latest/userguide/eb-global-endpoints.html) para mejorar la disponibilidad y la fiabilidad de sus aplicaciones basadas en eventos.
Una vez [configurado](https://docs.aws.amazon.com//eventbridge/latest/userguide/eb-global-endpoints.html#eb-ge-create-endpoint) el punto final EventBridge global, puedes enviarle eventos mediante el SDK for PHP.
**importante**
Para usar puntos finales EventBridge globales con el SDK para PHP, su entorno PHP debe tener instalada la [extensión AWS Common Runtime (AWS CRT)](guide_crt.md).
En el siguiente ejemplo, se utiliza el [PutEvents](https://docs.aws.amazon.com//aws-sdk-php/v3/api/api-eventbridge-2015-10-07.html#putevents)método de `EventBridgeClient` para enviar un único evento a un punto final 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]
]);
```
[Esta entrada de blog](https://aws.amazon.com/blogs//compute/introducing-global-endpoints-for-amazon-eventbridge/) contiene más información sobre los puntos finales EventBridge globales.