Skip to content

S3Files module#

Index > S3Files

Auto-generated documentation for S3Files type annotations stubs module mypy-boto3-s3files.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.42.85' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add S3Files service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and S3Files.

From PyPI with pip#

Install boto3-stubs for S3Files service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[s3files]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[s3files]'

# standalone installation
python -m pip install mypy-boto3-s3files

How to uninstall#

python -m pip uninstall -y mypy-boto3-s3files

Usage#

Code samples can be found in Examples.

S3FilesClient#

Type annotations and code completion for boto3.client("s3files") as S3FilesClient boto3 documentation

# S3FilesClient usage example

from boto3.session import Session

from mypy_boto3_s3files.client import S3FilesClient

def get_client() -> S3FilesClient:
    return Session().client("s3files")

Paginators#

Type annotations and code completion for paginators from boto3.client("s3files").get_paginator("...").

# ListAccessPointsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3files.paginator import ListAccessPointsPaginator

def get_list_access_points_paginator() -> ListAccessPointsPaginator:
    return Session().client("s3files").get_paginator("list_access_points"))

Literals#

Type annotations for literals used in methods and schema.

# ImportTriggerType usage example

from mypy_boto3_s3files.literals import ImportTriggerType

def get_value() -> ImportTriggerType:
    return "ON_DIRECTORY_FIRST_ACCESS"

Type definitions#

Type annotations for type definitions used in methods and schema.