Skip to content

WorkSpaces module#

Index > WorkSpaces

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

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 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"))

Literals#

Type annotations for literals used in methods and schemas.

# AccessPropertyValueType usage example

from mypy_boto3_workspaces.literals import AccessPropertyValueType

def get_value() -> AccessPropertyValueType:
    return "ALLOW"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccountModificationTypeDef usage example

from mypy_boto3_workspaces.type_defs import AccountModificationTypeDef

def get_value() -> AccountModificationTypeDef:
    return {
        "ModificationState": ...,
    }