Skip to content

WorkSpacesWeb module#

Index > WorkSpacesWeb

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

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

From PyPI with pip#

Install boto3-stubs for WorkSpacesWeb service.

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

# 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-web]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

WorkSpacesWebClient#

Type annotations and code completion for boto3.client("workspaces-web") as WorkSpacesWebClient boto3 documentation

# WorkSpacesWebClient usage example

from boto3.session import Session

from mypy_boto3_workspaces_web.client import WorkSpacesWebClient

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

Paginators#

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

# ListDataProtectionSettingsPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces_web.paginator import ListDataProtectionSettingsPaginator

def get_list_data_protection_settings_paginator() -> ListDataProtectionSettingsPaginator:
    return Session().client("workspaces-web").get_paginator("list_data_protection_settings"))

Literals#

Type annotations for literals used in methods and schema.

# AuthenticationTypeType usage example

from mypy_boto3_workspaces_web.literals import AuthenticationTypeType

def get_value() -> AuthenticationTypeType:
    return "IAM_Identity_Center"

Type definitions#

Type annotations for type definitions used in methods and schema.