seriousjelly/amazon-sqs-php-extended

An extension to the Amazon SQS client that enables sending and receiving messages up to 2GB via Amazon S3.

dev-master 2023-03-29 10:22 UTC

Requires

• php: >=5.6
• aws/aws-sdk-php: ^3.18
• ramsey/uuid: >=3.4

Requires (Dev)

• phpunit/phpunit: ^5.4

GPL-2.0

• Mateu Aguiló Bosch
• Chris Bratherton

• amazon
• s3
• aws
• sqs

README

The Amazon SQS Extended Client Library for PHP enables you to manage Amazon SQS message payloads with Amazon S3. This is especially useful for storing and retrieving messages with a message payload size greater than the current SQS limit of 256 KB, up to a maximum of 2 GB. Specifically, you can use this library to:

• Specify whether message payloads are always stored in Amazon S3 or only when a message's size exceeds a max size (defaults to 256 KB).
• Send a message that references a single message object stored in an Amazon S3 bucket.
• Get the corresponding message object from an Amazon S3 bucket.
• Delete the corresponding message object from an Amazon S3 bucket.

You can install this library using composer doing:

composer require seriousjelly/amazon-sqs-php-extended

Getting Started

• Sign up for AWS -- Before you begin, you need an AWS account. For more information about creating an AWS account and retrieving your AWS credentials, see AWS Account and Credentials in the AWS SDK for PHP Developer Guide.
• Sign up for Amazon SQS -- Go to the Amazon SQS console to sign up for the service.
• Minimum requirements -- To use the sample application, you'll need PHP 5.6+ and Composer. For more information about the requirements, see the Getting Started section of the Amazon SQS Developer Guide.
• Further information - Read the API documentation and the SQS & S3 recommendations.

Acknowledgements

• This library is inspired by the very similar Java library.

Feedback

• Give us feedback here.
• If you'd like to contribute a new feature or bug fix, we'd love to see Github pull requests from you.