AWS SDK for PHP

The AWS SDK for PHP is a powerful open-source library that enables PHP developers to integrate their applications with Amazon Web Services (AWS) services. It provides an intuitive, object-oriented API that simplifies the process of interacting with a wide range of AWS services, such as Amazon S3 (Simple Storage Service), Amazon EC2 (Elastic Compute Cloud), Amazon DynamoDB, Amazon SQS (Simple Queue Service), and many more.

Key features and benefits of using the AWS SDK for PHP include:

1. Comprehensive API Coverage: It offers client objects and methods for almost all AWS services, allowing developers to perform operations like uploading files to S3, managing EC2 instances, querying DynamoDB tables, sending emails via SES, and more.
2. Easy Installation and Management: The SDK is distributed via Composer, the popular PHP dependency manager, making installation and updates straightforward.
3. Credential Management: It supports various methods for managing AWS credentials, including environment variables, shared credentials files, IAM roles, and direct configuration, ensuring secure access to AWS resources.
4. Simplified Error Handling: The SDK provides a consistent exception hierarchy for handling API errors, making it easier to build robust and fault-tolerant applications.
5. Built-in Features: It includes helpers for common tasks like pagination (iterating through large result sets), waiters (waiting for resources to reach a certain state), and request signing.
6. Performance and Scalability: The SDK is designed to be efficient and work well in cloud environments, supporting asynchronous operations and connection pooling where applicable.

To use the SDK, you typically install it via Composer, configure your AWS credentials and region, and then instantiate a client object for the specific AWS service you wish to interact with. Once a client is instantiated, you can call its methods corresponding to the AWS API operations.

Example Code

<?php

require 'vendor/autoload.php';

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

// --- Configuration --- //
// You should configure your AWS credentials and region. 
// The SDK automatically looks for credentials in environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY),
// shared credential files (~/.aws/credentials), or IAM roles if running on EC2.
// For demonstration, we'll explicitly set the region.
$region = 'us-east-1'; // Example region
$bucketName = 'my-unique-php-sdk-test-bucket-123456'; // Replace with a unique bucket name
$key = 'hello_world.txt';
$fileContent = 'Hello from AWS SDK for PHP!';

// --- Instantiate an S3 Client --- //
try {
    $s3Client = new S3Client([
        'version'     => 'latest',
        'region'      => $region,
        // 'credentials' => [
        //     'key'    => 'YOUR_AWS_ACCESS_KEY_ID',
        //     'secret' => 'YOUR_AWS_SECRET_ACCESS_KEY',
        // ],
    ]);

    echo "S3 Client initialized successfully.\n\n";

    // --- Create an S3 Bucket (optional, for demonstration) ---
    // It's good practice to check if the bucket exists before creating.
    if (!$s3Client->doesBucketExist($bucketName)) {
        echo "Creating bucket: {$bucketName}\n";
        $s3Client->createBucket(['Bucket' => $bucketName]);
        $s3Client->waitUntil('BucketExists', ['Bucket' => $bucketName]);
        echo "Bucket '{$bucketName}' created.\n";
    } else {
        echo "Bucket '{$bucketName}' already exists.\n";
    }

    // --- Upload an object to S3 ---
    echo "Uploading object '{$key}' to bucket '{$bucketName}'...\n";
    $result = $s3Client->putObject([
        'Bucket' => $bucketName,
        'Key'    => $key,
        'Body'   => $fileContent,
        'ACL'    => 'private' // or 'public-read' if you want it publicly accessible
    ]);

    echo "Object uploaded successfully! Object URL: " . $result['ObjectURL'] . "\n";

    // --- List objects in the S3 bucket ---
    echo "\nListing objects in bucket '{$bucketName}':\n";
    $objects = $s3Client->listObjects(['Bucket' => $bucketName]);

    if (isset($objects['Contents'])) {
        foreach ($objects['Contents'] as $object) {
            echo "- " . $object['Key'] . " (Size: " . $object['Size'] . " bytes, Last Modified: " . $object['LastModified'] . ")\n";
        }
    } else {
        echo "No objects found in the bucket.\n";
    }

    // --- Download an object from S3 ---
    echo "\nDownloading object '{$key}'...\n";
    $result = $s3Client->getObject([
        'Bucket' => $bucketName,
        'Key'    => $key
    ]);
    $downloadedContent = (string) $result['Body'];
    echo "Downloaded content: " . $downloadedContent . "\n";

    // --- Clean up (optional: delete the uploaded object and then the bucket) ---
    echo "\nCleaning up: Deleting object '{$key}'...\n";
    $s3Client->deleteObject([
        'Bucket' => $bucketName,
        'Key'    => $key,
    ]);
    echo "Object '{$key}' deleted.\n";

    // Be careful when deleting buckets, especially in production environments.
    // echo "Deleting bucket '{$bucketName}'...\n";
    // $s3Client->deleteBucket(['Bucket' => $bucketName]);
    // $s3Client->waitUntil('BucketNotExists', ['Bucket' => $bucketName]);
    // echo "Bucket '{$bucketName}' deleted.\n";

} catch (AwsException $e) {
    // Display error message
    echo "Error: " . $e->getMessage() . "\n";
    echo "AWS Error Code: " . $e->getAwsErrorCode() . "\n";
    echo "AWS Error Type: " . $e->getAwsErrorType() . "\n";
    echo "AWS Request ID: " . $e->getAwsRequestId() . "\n";
} catch (Exception $e) {
    echo "General Error: " . $e->getMessage() . "\n";
}

?>

Example Code

Related Topics