Skip to content

EFS module#

Index > EFS

Auto-generated documentation for EFS type annotations stubs module mypy-boto3-efs.

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.38.19' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add EFS 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 EFS.

From PyPI with pip#

Install boto3-stubs for EFS service.

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

# 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[efs]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

EFSClient#

Type annotations and code completion for boto3.client("efs") as EFSClient boto3 documentation

# EFSClient usage example

from boto3.session import Session

from mypy_boto3_efs.client import EFSClient

def get_client() -> EFSClient:
    return Session().client("efs")

Paginators#

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

# DescribeAccessPointsPaginator usage example

from boto3.session import Session

from mypy_boto3_efs.paginator import DescribeAccessPointsPaginator

def get_describe_access_points_paginator() -> DescribeAccessPointsPaginator:
    return Session().client("efs").get_paginator("describe_access_points"))

Literals#

Type annotations for literals used in methods and schema.

# DeletionModeType usage example

from mypy_boto3_efs.literals import DeletionModeType

def get_value() -> DeletionModeType:
    return "ALL_CONFIGURATIONS"

Type definitions#

Type annotations for type definitions used in methods and schema.