Skip to content

FSx module#

Index > FSx

Auto-generated documentation for FSx type annotations stubs module mypy-boto3-fsx.

How to install#

VSCode extension#

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

Click Modify and select boto3 common and FSx.

From PyPI with pip#

Install boto3-stubs for FSx service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

FSxClient#

Type annotations and code completion for boto3.client("fsx") as FSxClient boto3 documentation

# FSxClient usage example

from boto3.session import Session

from mypy_boto3_fsx.client import FSxClient

def get_client() -> FSxClient:
    return Session().client("fsx")

Paginators#

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

# DescribeBackupsPaginator usage example

from boto3.session import Session

from mypy_boto3_fsx.paginator import DescribeBackupsPaginator

def get_describe_backups_paginator() -> DescribeBackupsPaginator:
    return Session().client("fsx").get_paginator("describe_backups"))

Literals#

Type annotations for literals used in methods and schemas.

# AdministrativeActionTypeType usage example

from mypy_boto3_fsx.literals import AdministrativeActionTypeType

def get_value() -> AdministrativeActionTypeType:
    return "FILE_SYSTEM_ALIAS_ASSOCIATION"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActiveDirectoryBackupAttributesTypeDef usage example

from mypy_boto3_fsx.type_defs import ActiveDirectoryBackupAttributesTypeDef

def get_value() -> ActiveDirectoryBackupAttributesTypeDef:
    return {
        "DomainName": ...,
    }