Skip to content

WorkspacesInstances module#

Index > WorkspacesInstances

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

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

From PyPI with pip#

Install boto3-stubs for WorkspacesInstances service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

WorkspacesInstancesClient#

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

# WorkspacesInstancesClient usage example

from boto3.session import Session

from mypy_boto3_workspaces_instances.client import WorkspacesInstancesClient

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

Paginators#

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

# ListInstanceTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces_instances.paginator import ListInstanceTypesPaginator

def get_list_instance_types_paginator() -> ListInstanceTypesPaginator:
    return Session().client("workspaces-instances").get_paginator("list_instance_types"))

Literals#

Type annotations for literals used in methods and schema.

# AmdSevSnpEnumType usage example

from mypy_boto3_workspaces_instances.literals import AmdSevSnpEnumType

def get_value() -> AmdSevSnpEnumType:
    return "disabled"

Type definitions#

Type annotations for type definitions used in methods and schema.