Type annotations for boto3 WorkspacesInstances

1.42.31 · active · verified Sat Apr 11

mypy-boto3-workspaces-instances provides comprehensive type annotations for the `boto3` WorkspacesInstances service, compatible with mypy, Pyright, VSCode, and other type-checking tools. It enhances developer experience by offering static type checking and auto-completion for `boto3.client('workspaces-instances')` calls. This library is automatically generated by `mypy-boto3-builder` and is currently at version 1.42.31, with frequent updates to align with new `boto3` releases.

Warnings

breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0. If you are using this version of the stubs, you must use Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or later.
breaking TypeDef naming conventions changed in `mypy-boto3-builder` version 8.9.0. This includes shorter names for packed method arguments (e.g., `RequestRequestTypeDef` becoming `RequestTypeDef`) and moving `Extra` postfixes.
Fix: Update your code to use the new TypeDef names. Refer to the `mypy-boto3-workspaces-instances.type_defs` module for correct names.
gotcha This package provides type stubs only; it does not include the `boto3` runtime library itself. `boto3` must be installed separately for your application to function.
Fix: Ensure `pip install boto3` is part of your project dependencies.
gotcha PyCharm may experience slow performance or high CPU usage when dealing with `Literal` overloads in `mypy-boto3` due to a known IDE issue (PY-40997).
Fix: Consider using `boto3-stubs-lite` (if appropriate for your use case) or disabling PyCharm's internal type checker and relying on external tools like `mypy` or `Pyright`.

Install

pip install mypy-boto3-workspaces-instances Install standalone package
pip install 'boto3-stubs[workspaces]' # or boto3-stubs-lite[workspaces] Install as part of boto3-stubs (recommended)

Imports

WorkspacesInstancesClient
```
from mypy_boto3_workspaces_instances.client import WorkspacesInstancesClient
```
Type annotation for the WorkspacesInstances Boto3 client.
AcceptAccountLinkInvitationRequestTypeDef
```
from mypy_boto3_workspaces_instances.type_defs import AcceptAccountLinkInvitationRequestTypeDef
```
Example of importing a service-specific TypedDict for request/response bodies.

AGAModeForDirectoryEnumType

from mypy_boto3_workspaces_instances.literals import AGAModeForDirectoryEnumType

Example of importing a service-specific Literal type.

Quickstart

This quickstart demonstrates how to initialize a typed `boto3` client for WorkspacesInstances and make a basic API call. Type annotations ensure that arguments and return values are correctly type-checked by tools like `mypy` or `Pyright`.

import boto3
from mypy_boto3_workspaces_instances.client import WorkspacesInstancesClient
from mypy_boto3_workspaces_instances.type_defs import DescribeAccountLinksResultTypeDef

def list_workspaces_instances() -> None:
    # Initialize the Boto3 client with type annotation
    client: WorkspacesInstancesClient = boto3.client('workspaces-instances')

    # Example API call with type-checked parameters and return value
    response: DescribeAccountLinksResultTypeDef = client.describe_account_links(
        LinkStatusFilter=['LINKED']
    )

    print(f"Account links: {response.get('AccountLinks')}")

if __name__ == "__main__":
    list_workspaces_instances()

view raw JSON →