Examples

Index > S3 > Examples

Auto-generated documentation for S3 type annotations stubs module types-aiobotocore-s3.

Client

Implicit type annotations

Can be used with types-aiobotocore[s3] package installed.

Write your S3 code as usual, type checking and code completion should work out of the box.

# S3Client usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("s3") as client:  # (1)
    result = await client.abort_multipart_upload()  # (2)

1. client: S3Client
2. result: AbortMultipartUploadOutputTypeDef

# ListMultipartUploadsPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("s3") as client:  # (1)
    paginator = client.get_paginator("list_multipart_uploads")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: S3Client
2. paginator: ListMultipartUploadsPaginator
3. item: ListMultipartUploadsOutputTypeDef

# BucketExistsWaiter usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("s3") as client:  # (1)
    waiter = client.get_waiter("bucket_exists")  # (2)
    await waiter.wait()

1. client: S3Client
2. waiter: BucketExistsWaiter

Explicit type annotations

With types-aiobotocore-lite[s3] or a standalone types_aiobotocore_s3 package, you have to explicitly specify client: S3Client type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# S3Client usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_s3.client import S3Client
from types_aiobotocore_s3.type_defs import AbortMultipartUploadOutputTypeDef
from types_aiobotocore_s3.type_defs import AbortMultipartUploadRequestRequestTypeDef


session = get_session()

async with session.create_client("s3") as client:
    client: S3Client
    kwargs: AbortMultipartUploadRequestRequestTypeDef = {...}
    result: AbortMultipartUploadOutputTypeDef = await client.abort_multipart_upload(**kwargs)

# ListMultipartUploadsPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_s3.client import S3Client
from types_aiobotocore_s3.paginator import ListMultipartUploadsPaginator
from types_aiobotocore_s3.type_defs import ListMultipartUploadsOutputTypeDef


session = get_session()

async with session.create_client("s3") as client:
    client: S3Client
    paginator: ListMultipartUploadsPaginator = client.get_paginator("list_multipart_uploads")
    async for item in paginator.paginate(...):
        item: ListMultipartUploadsOutputTypeDef
        print(item)

# BucketExistsWaiter usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_s3.client import S3Client
from types_aiobotocore_s3.waiter import BucketExistsWaiter


session = get_session()

async with session.create_client("s3") as client:
    client: S3Client
    waiter: BucketExistsWaiter = client.get_waiter("bucket_exists")
    await waiter.wait()