diff options
| author | Yuval Lifshitz <yuvalif@yahoo.com> | 2019-10-15 08:57:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-15 08:57:27 +0200 |
| commit | 1531cf5d04fc342b27da186b11f1338e0d19b7eb (patch) | |
| tree | 1596eeb7ab3f18cc351b12b061273b26ad5cfb97 /doc/radosgw | |
| parent | Merge pull request #30874 from uweigand/add-cycles-ibmz (diff) | |
| parent | rgw/examples: adding info on boto3 extensions to docs (diff) | |
| download | ceph-1531cf5d04fc342b27da186b11f1338e0d19b7eb.tar.xz ceph-1531cf5d04fc342b27da186b11f1338e0d19b7eb.zip | |
Merge pull request #30600 from yuvalif/boto3_extensions_examples
rgw/examples: adding examples for boto3 extensions to AWS S3
Diffstat (limited to 'doc/radosgw')
| -rw-r--r-- | doc/radosgw/s3/python.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/radosgw/s3/python.rst b/doc/radosgw/s3/python.rst index a2c6a59d1d4..01777f75d74 100644 --- a/doc/radosgw/s3/python.rst +++ b/doc/radosgw/s3/python.rst @@ -169,3 +169,18 @@ The output of this will look something like:: http://objects.dreamhost.com/my-bucket-name/hello.txt http://objects.dreamhost.com/my-bucket-name/secret_plans.txt?Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Expires=1316027075&AWSAccessKeyId=XXXXXXXXXXXXXXXXXXX +Using S3 API Extensions +----------------------- + +To use the boto3 client to tests the RadosGW extensions to the S3 API, the `extensions file`_ should be placed under: ``~/.aws/models/s3/2006-03-01/`` directory. +For example, unordered list of objects could be fetched using: + +.. code-block:: python + + print conn.list_objects(Bucket='my-new-bucket', AllowUnordered=True) + + +Without the extensions file, in the above example, boto3 would complain that the ``AllowUnordered`` argument is invalid. + + +.. _extensions file: https://github.com/ceph/ceph/blob/master/examples/examples/boto3/service-2.sdk-extras.json |