WorkSpaces module

Index > WorkSpaces

Auto-generated documentation for WorkSpaces type annotations stubs module mypy-boto3-workspaces.

How to install

Generate locally (recommended)

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.35.97' mypy_boto3_builder
2. Select boto3-stubs AWS SDK.
3. Add WorkSpaces 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 WorkSpaces.

From PyPI with pip

Install boto3-stubs for WorkSpaces service.

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

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

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

How to uninstall

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

Usage

Code samples can be found in Examples.

WorkSpacesClient

Type annotations and code completion for boto3.client("workspaces") as WorkSpacesClient boto3 documentation

# WorkSpacesClient usage example

from boto3.session import Session

from mypy_boto3_workspaces.client import WorkSpacesClient

def get_client() -> WorkSpacesClient:
    return Session().client("workspaces")

Paginators

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

# DescribeAccountModificationsPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeAccountModificationsPaginator

def get_describe_account_modifications_paginator() -> DescribeAccountModificationsPaginator:
    return Session().client("workspaces").get_paginator("describe_account_modifications"))

• DescribeAccountModificationsPaginator
• DescribeIpGroupsPaginator
• DescribeWorkspaceBundlesPaginator
• DescribeWorkspaceDirectoriesPaginator
• DescribeWorkspaceImagesPaginator
• DescribeWorkspacesConnectionStatusPaginator
• DescribeWorkspacesPaginator
• ListAccountLinksPaginator
• ListAvailableManagementCidrRangesPaginator

Literals

Type annotations for literals used in methods and schema.

# AGAModeForDirectoryEnumType usage example

from mypy_boto3_workspaces.literals import AGAModeForDirectoryEnumType

def get_value() -> AGAModeForDirectoryEnumType:
    return "DISABLED"

• AGAModeForDirectoryEnumType
• AGAModeForWorkSpaceEnumType
• AGAPreferredProtocolForDirectoryType