This package is mostly just a wrapper combining the great work of boto3 and aiobotocore.
aiobotocore allows you to use near enough all of the boto3 client commands in an async manner just by prefixing the command with await.
With aioboto3 you can now usxe the higher level APIs provided by boto3 in an asynchronous manner. Mainly I developed this as I wanted to use the boto3 dynamodb Table object in some async microservices.
Whilst all resources in boto3 should work I havent tested them all, so if what your after is not in the table below then try it out, if it works drop me an issue with a simple test case and I'll add it to the table.
Services | Status |
---|---|
DynamoDB Service Resource | Tested and working |
DynamoDB Table | Tested and working |
Simple example of using aioboto3 to put items into a dynamodb table
import asyncio
import aioboto3
from boto3.dynamodb.conditions import Key
async def main():
async with aioboto3.resource('dynamodb', region_name='eu-central-1') as dynamo_resource:
table = dynamo_resource.Table('test_table')
await table.put_item(
Item={'pk': 'test1', 'col1': 'some_data'}
)
result = await table.query(
KeyConditionExpression=Key('pk').eq('test1')
)
print(result['Items'])
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
# Outputs:
# [{'col1': 'some_data', 'pk': 'test1'}]
As this library literally wraps boto3, its inevitable that some things won't magically be async.
s3_client.copy
This is performed by the s3transfer module. I believes3_client.copy_object
performs the same function
Fixed:
s3_client.download_file*
This is performed by the s3transfer module. -- Patched with get_objects3_client.upload_file*
This is performed by the s3transfer module. -- Patched with put_objectdynamodb_resource.Table.batch_writer
This now returns an async context manager which performs the same function
Docs are here - https://aioboto3.readthedocs.io/en/latest/
Examples here - https://aioboto3.readthedocs.io/en/latest/usage.html
- Closely mimics the usage of boto3.
- More Examples
- Set up docs
- Look into monkey-patching the aws xray sdk to be more async if it needs to be.
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template. It also makes use of the aiobotocore and boto3 libraries. All the credit goes to them, this is mainly a wrapper with some examples.