Skip to content

WorkSpacesWeb module#

Index > WorkSpacesWeb

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

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

Literals#

Type annotations for literals used in methods and schemas.

# AuthenticationTypeType usage example

from mypy_boto3_workspaces_web.literals import AuthenticationTypeType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AssociateBrowserSettingsRequestRequestTypeDef usage example

from mypy_boto3_workspaces_web.type_defs import AssociateBrowserSettingsRequestRequestTypeDef

def get_value() -> AssociateBrowserSettingsRequestRequestTypeDef:
    return {
        "browserSettingsArn": ...,
        "portalArn": ...,
    }