S3Files module#
Index > S3Files
Auto-generated documentation for S3Files type annotations stubs module types-aiobotocore-s3files.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore package locally with mypy-boto3-builder.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==3.7.0' mypy-boto3-builder - Select
aiobotocoreAWS SDK. - Add
S3Filesservice. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore for S3Files service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[s3files]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[s3files]'
# standalone installation
python -m pip install types-aiobotocore-s3files
How to uninstall#
python -m pip uninstall -y types-aiobotocore-s3files
Usage#
Code samples can be found in Examples.
S3FilesClient#
Type annotations and code completion for session.create_client("s3files") as S3FilesClient
boto3 documentation
# S3FilesClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_s3files.client import S3FilesClient
session = get_session()
async with session.create_client("s3files") as client:
client: S3FilesClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("s3files").get_paginator("...").
# ListAccessPointsPaginator usage example
from types_aiobotocore_s3files.paginator import ListAccessPointsPaginator
def get_list_access_points_paginator() -> ListAccessPointsPaginator:
return client.get_paginator("list_access_points"))
- ListAccessPointsPaginator
- ListFileSystemsPaginator
- ListMountTargetsPaginator
- ListTagsForResourcePaginator
Literals#
Type annotations for literals used in methods and schema.
# ImportTriggerType usage example
from types_aiobotocore_s3files.literals import ImportTriggerType
def get_value() -> ImportTriggerType:
return "ON_DIRECTORY_FIRST_ACCESS"
- ImportTriggerType
- IpAddressTypeType
- LifeCycleStateType
- ListAccessPointsPaginatorName
- ListFileSystemsPaginatorName
- ListMountTargetsPaginatorName
- ListTagsForResourcePaginatorName
- S3FilesServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- TagTypeDef
- PosixUserOutputTypeDef
- ResponseMetadataTypeDef
- CreateMountTargetRequestTypeDef
- CreationPermissionsTypeDef
- DeleteAccessPointRequestTypeDef
- DeleteFileSystemPolicyRequestTypeDef
- DeleteFileSystemRequestTypeDef
- DeleteMountTargetRequestTypeDef
- ExpirationDataRuleTypeDef
- GetAccessPointRequestTypeDef
- GetFileSystemPolicyRequestTypeDef
- GetFileSystemRequestTypeDef
- GetMountTargetRequestTypeDef
- GetSynchronizationConfigurationRequestTypeDef
- ImportDataRuleTypeDef
- PaginatorConfigTypeDef
- ListAccessPointsRequestTypeDef
- ListFileSystemsDescriptionTypeDef
- ListFileSystemsRequestTypeDef
- ListMountTargetsDescriptionTypeDef
- ListMountTargetsRequestTypeDef
- ListTagsForResourceRequestTypeDef
- PosixUserTypeDef
- PutFileSystemPolicyRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateMountTargetRequestTypeDef
- CreateFileSystemRequestTypeDef
- TagResourceRequestTypeDef
- CreateFileSystemResponseTypeDef
- CreateMountTargetResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetFileSystemPolicyResponseTypeDef
- GetFileSystemResponseTypeDef
- GetMountTargetResponseTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateMountTargetResponseTypeDef
- RootDirectoryTypeDef
- GetSynchronizationConfigurationResponseTypeDef
- PutSynchronizationConfigurationRequestTypeDef
- ListAccessPointsRequestPaginateTypeDef
- ListFileSystemsRequestPaginateTypeDef
- ListMountTargetsRequestPaginateTypeDef
- ListTagsForResourceRequestPaginateTypeDef
- ListFileSystemsResponseTypeDef
- ListMountTargetsResponseTypeDef
- PosixUserUnionTypeDef
- CreateAccessPointResponseTypeDef
- GetAccessPointResponseTypeDef
- ListAccessPointsDescriptionTypeDef
- CreateAccessPointRequestTypeDef
- ListAccessPointsResponseTypeDef