===============
AWS SDK for PHP
===============

.. toctree::
    :hidden:

    getting-started/index
    guide/index
    service/index
    examples/index
    faq
    glossary

The **AWS SDK for PHP** enables PHP developers to use
`Amazon Web Services <http://aws.amazon.com/>`_ from their PHP code, and build
robust applications and software using services like Amazon S3, Amazon
DynamoDB, Amazon Glacier, etc. You can get started in minutes by installing the
SDK through Composer — by requiring the ``aws/aws-sdk-php`` package — or by
downloading the standalone `aws.zip <http://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.zip>`_
or `aws.phar <http://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.phar>`_ files.

External links: `API Docs <http://docs.aws.amazon.com/aws-sdk-php/v3/api/>`_
| `GitHub <https://github.com/aws/aws-sdk-php>`_
| `Twitter <https://twitter.com/awsforphp>`_
| `Gitter <https://gitter.im/aws/aws-sdk-php>`_
| `Blog <http://blogs.aws.amazon.com/php>`_
| `Forum <https://forums.aws.amazon.com/forum.jspa?forumID=80>`_
| `Packagist <https://packagist.org/packages/aws/aws-sdk-php>`_

.. note::

    Are you migrating your project's code from using Version 2 of the SDK to
    Version 3? If so, you should read our :doc:`guide/migration`.


Getting Started
---------------

1. :doc:`getting-started/requirements`
2. :doc:`getting-started/installation`
3. :doc:`getting-started/basic-usage`


SDK Guides
----------

* :doc:`guide/configuration`
* :doc:`guide/credentials`
* :doc:`guide/commands`
* :doc:`guide/promises`
* :doc:`guide/handlers-and-middleware`
* :doc:`guide/streams`
* :doc:`guide/paginators`
* :doc:`guide/waiters`
* :doc:`guide/jmespath`
* :doc:`guide/migration`


Service-Specific Features
-------------------------

* :doc:`service/cloudsearch-custom-requests`
* :doc:`service/cloudfront-signed-url`
* :doc:`service/dynamodb-session-handler`
* :doc:`service/es-data-plane`
* :doc:`service/s3-multipart-upload`
* :doc:`service/s3-multiregion-client`
* :doc:`service/s3-presigned-post`
* :doc:`service/s3-presigned-url`
* :doc:`service/s3-stream-wrapper`
* :doc:`service/s3-transfer`

Examples
--------
* :doc:`examples/cw-examples`
* :doc:`examples/ec2-examples`
* :doc:`examples/iam-examples`
* :doc:`examples/s3-examples`
* :doc:`examples/sqs-examples`

Reference
---------

* :doc:`faq`
* :doc:`glossary`
* `Contributing to the SDK <https://github.com/aws/aws-sdk-php/blob/master/CONTRIBUTING.md>`_
* `Guzzle Documentation <http://guzzlephp.org>`_


.. _supported-services:

API Documentation
-----------------

API documentation for the SDK can be found at http://docs.aws.amazon.com/aws-sdk-php/v3/api/.
