AWS SDK for PHP

https://github.com/aws/aws-sdk-php
Admin
AWS SDK for PHP makes it easy for developers to access Amazon Web Services in their PHP code using...
Tokens:203,867
Snippets:1,391
Trust Score:9.7
License:Apache-2.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install AWS SDK for PHP via Composer

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

Run this command in your project's base directory to add the aws/aws-sdk-php package as a dependency. Requires PHP >= 8.1 and Composer installed globally.

```bash
composer require aws/aws-sdk-php
```

--------------------------------

### Configure LambdaClient for old 2014-11-11 preview API

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

Use this snippet to continue using the old 2014-11-11 preview API for AWS Lambda when upgrading from 2.7 to 2.8. The Lambda service API changed significantly, but this configuration preserves backward compatibility for the `invokeAsync()` operation.

```php
use Aws\Lambda\LambdaClient;

$client = LambdaClient::factory(array(
    'version' => '2014-11-11',
    // ...
));
```

--------------------------------

### Install PHPStan and Psalm via Composer

Source: https://github.com/aws/aws-sdk-php/blob/master/tests/Build/PhpStan/README.md

Install PHPStan 2.2 or newer and Psalm 5 or newer globally. PHPStan 2.2+ is required because earlier versions reject bare `...` in unsealed array shapes; Psalm 5+ reads `@phpstan-method` via cross-tag support.

```bash
composer global require phpstan/phpstan:^2.2 vimeo/psalm:^5
```

--------------------------------

### S3 ObjectExists waiter with associative array

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

Use the ObjectExists waiter with an associative array for Bucket and Key parameters, and optionally set waiter.max_attempts to control retries.

```php
$s3Client->waitUntilObjectExists(array(
    'Bucket' => 'foo',
    'Key' => 'bar',
    'waiter.max_attempts' => 3
));
```

--------------------------------

### DynamoDB Client with version 2011-12-05

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

Use the 'version' configuration setting to switch back to the 2011-12-05 API when upgrading to SDK 2.3, avoiding breaking changes from the new 2012-08-10 API.

```php
use Aws\DynamoDb\DynamoDbClient;

$client = DynamoDbClient::factory(array(
    'key'     => '<aws access key>',
    'secret'  => '<aws secret key>',
    'region'  => '<region name>',
    'version' => '2011-12-05'
));
```

--------------------------------

### Update RequestSpotInstances MonitoringEnabled to Monitoring.Enabled

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

Shows the old and new request structures for the Amazon EC2 RequestSpotInstances operation after the LaunchConfiguration.MonitoringEnabled parameter was renamed to LaunchConfiguration.Monitoring.Enabled. Only affects code using this specific parameter; update the request to nest the Enabled flag under the Monitoring array.

```php
// The OLD way
$result = $ec2->requestSpotInstances(array(
    // ...
    'LaunchSpecification' => array(
        // ...
        'MonitoringEnabled' => true,
        // ...
    ),
    // ...
));
```

```php
// The NEW way
$result = $ec2->requestSpotInstances(array(
    // ...
    'LaunchSpecification' => array(
        // ...
        'Monitoring' => array(
            'Enabled' => true,
        ),
        // ...
    ),
    // ...
));
```

--------------------------------

### CloudTrail createTrail() Old vs New Parameter Format

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

Shows the breaking change in the AWS SDK for PHP for CloudTrail's createTrail() and updateTrail() methods. The old way passed a nested 'trail' object, while the new way passes individual parameters directly. Update your code to use the new format before the deprecated fields are removed.

```php
// The OLD way
$cloudTrail->createTrail(array(
    'trail' => array(
        'Name'         => 'TRAIL_NAME',
        'S3BucketName' => 'BUCKET_NAME',
    )
));
```

```php
// The NEW way
$cloudTrail->createTrail(array(
    'Name'         => 'TRAIL_NAME',
    'S3BucketName' => 'BUCKET_NAME',
));
```

--------------------------------

### Config file with DynamoDB version override

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

Modify a config file used with Aws\Common\Aws to set the DynamoDB client version to 2011-12-05, overriding the default new API.

```json
{
    "includes": ["_aws"],
    "services": {
        "default_settings": {
            "params": {
                "key": "<aws access key>",
                "secret": "<aws secret key>",
                "region": "<region name>"
            }
        },
        "dynamodb": {
            "extends": "dynamodb",
            "params": {
                "version": "2011-12-05"
            }
        }
    }
}
```

--------------------------------

### Configure CloudSearchClient for old 2011-02-01 API

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

Use this snippet to continue using the older 2011-02-01 API for Amazon CloudSearch when upgrading from 2.5 to 2.6. Version 2.6 defaults to the 2013-01-01 API, which includes breaking changes; this configuration preserves the older API.

```php
use Aws\CloudSearch\CloudSearchClient;

$client = CloudSearchClient::factory(array(
    'key'     => '<aws access key>',
    'secret'  => '<aws secret key>',
    'region'  => '<region name>',
    'version' => '2011-02-01',
));
```

--------------------------------

### Changelog Document JSON Structure

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

Place a JSON blob in the .changes/nextrelease folder. It contains a type, category, and description. The type can be feature, enhancement, bugfix, or documentation, and the category should correspond to a Service subfolder of the src directory or be an empty string for core components.

```json
[
    {
        "type": "feature|enhancement|bugfix",
        "category": "Target of Update",
        "description": "English language simple description of your update."
    }
]
```

--------------------------------

### Create an Amazon S3 client with S3Client

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

Instantiate an Amazon S3 client using the AWS SDK for PHP. Requires the Composer autoloader and specifies the API version and region (us-west-2).

```php
<?php
// Require the Composer autoloader.
require 'vendor/autoload.php';

use Aws\S3\S3Client;

// Instantiate an Amazon S3 client.
$s3 = new S3Client([
    'version' => 'latest',
    'region'  => 'us-west-2'
]);
```

--------------------------------

### Upload a file to Amazon S3 with putObject

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

Uploads a file to an S3 bucket with public-read access. The file size and type are determined by the SDK. Catches S3Exception and prints an error message on failure.

```php
<?php
// Upload a publicly accessible file. The file size and type are determined by the SDK.
try {
    $s3->putObject([
        'Bucket' => 'my-bucket',
        'Key'    => 'my-object',
        'Body'   => fopen('/path/to/file', 'r'),
        'ACL'    => 'public-read',
    ]);
} catch (Aws\S3\Exception\S3Exception $e) {
    echo "There was an error uploading the file.\n";
}
```

--------------------------------

### Run PHPStan and Psalm Analysis

Source: https://github.com/aws/aws-sdk-php/blob/master/tests/Build/PhpStan/README.md

Run static analysis from the SDK root using the provided configuration files. Both commands should exit clean against `fixture.php`; an `InvalidDocblock` error indicates a bug in the generated annotations.

```bash
phpstan analyze --configuration=tests/Build/PhpStan/phpstan.neon
```

```bash
psalm --config=tests/Build/PhpStan/psalm.xml --no-cache
```

--------------------------------

### Create an Amazon S3 Encryption Client

Source: https://github.com/aws/aws-sdk-php/blob/master/src/S3/Crypto/README.md

Instantiate an S3 client and wrap it with S3EncryptionClientV3. Requires PHP >= 8.1 and the openssl extension.

```php
<?php
// Require the Composer autoloader.
require 'vendor/autoload.php';

use Aws\S3\S3Client;
use Aws\S3\Crypto\S3EncryptionClientV3;

// Instantiate an Amazon S3 client.
$s3 = new S3Client([
    'version' => 'latest',
    'region'  => 'us-west-2'
]);

// Instantiate an Amazon S3 Encryption Client V3.
$client = new S3EncryptionClientV3($s3Client);
```

--------------------------------

### Configure composer.json to Remove Unused AWS Services

Source: https://github.com/aws/aws-sdk-php/blob/master/src/Script/Composer/README.md

Add the removeUnusedServices script to your composer.json to automatically delete unused AWS SDK services during pre-autoload-dump. Specify the services to keep in the extra.aws/aws-sdk-php array; exact client namespace matches are required or an error is thrown. S3, Kms, SSO, and Sts are always excluded from deletion.

```json
{
    "require": {
        "aws/aws-sdk-php": "<version here>"
    },
    "scripts": {
        "pre-autoload-dump": "Aws\\Script\\Composer\\Composer::removeUnusedServices"
    },
    "extra": {
        "aws/aws-sdk-php": [
            "Ec2",
            "CloudWatch"
        ]
    }
}
```

--------------------------------

### Upload a file to Amazon S3 using client side encryption

Source: https://github.com/aws/aws-sdk-php/blob/master/src/S3/Crypto/README.md

Configure a KMS materials provider and upload an encrypted object with S3EncryptionClientV3. Uses GCM cipher with 256-bit key size and sets a commitment policy.

```php
$kmsKeyId = 'kms-key-id';
$materialsProvider = new KmsMaterialsProviderV3(
    new KmsClient([
        'profile' => 'default',
        'region' => 'us-east-1',
        'version' => 'latest',
    ]),
    $kmsKeyId
);

$bucket = 'the-bucket-name';
$key = 'the-file-name';
$cipherOptions = [
    'Cipher' => 'gcm',
    'KeySize' => 256,
    // Additional configuration options
];

$result = $client->putObject([
    '@MaterialsProvider' => $materialsProvider,
    '@CipherOptions' => $cipherOptions,
    '@CommitmentPolicy' => 'REQUIRE_ENCRYPT_REQUIRE_DECRYPT',
    '@KmsEncryptionContext' => ['context-key' => 'context-value'],
    'Bucket' => $bucket,
    'Key' => $key,
    'Body' => fopen('file-to-encrypt.txt', 'r'),
]);
```
Tokens:
Raw