Examples

Index > WorkSpaces > Examples

Auto-generated documentation for WorkSpaces type annotations stubs module types-aiobotocore-workspaces.

Client

Implicit type annotations

Can be used with types-aioboto3[workspaces] package installed.

Write your WorkSpaces code as usual, type checking and code completion should work out of the box.

# WorkSpacesClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("workspaces") as client:  # (1)
    result = await client.associate_connection_alias()  # (2)

1. client: WorkSpacesClient
2. result: AssociateConnectionAliasResultTypeDef

# DescribeAccountModificationsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("workspaces") as client:  # (1)
    paginator = client.get_paginator("describe_account_modifications")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: WorkSpacesClient
2. paginator: DescribeAccountModificationsPaginator
3. item: DescribeAccountModificationsResultTypeDef

Explicit type annotations

With types-aioboto3-lite[workspaces] or a standalone types_aiobotocore_workspaces package, you have to explicitly specify client: WorkSpacesClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# WorkSpacesClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_workspaces.client import WorkSpacesClient
from types_aiobotocore_workspaces.type_defs import AssociateConnectionAliasResultTypeDef
from types_aiobotocore_workspaces.type_defs import AssociateConnectionAliasRequestRequestTypeDef


session = Session()

client: WorkSpacesClient
async with session.client("workspaces") as client:  # (1)
    kwargs: AssociateConnectionAliasRequestRequestTypeDef = {...}  # (2)
    result: AssociateConnectionAliasResultTypeDef = await client.associate_connection_alias(**kwargs)  # (3)

1. client: WorkSpacesClient
2. kwargs: AssociateConnectionAliasRequestRequestTypeDef
3. result: AssociateConnectionAliasResultTypeDef

# DescribeAccountModificationsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_workspaces.client import WorkSpacesClient
from types_aiobotocore_workspaces.paginator import DescribeAccountModificationsPaginator
from types_aiobotocore_workspaces.type_defs import DescribeAccountModificationsResultTypeDef


session = Session()

client: WorkSpacesClient
async with session.client("workspaces") as client:  # (1)
    paginator: DescribeAccountModificationsPaginator = client.get_paginator("describe_account_modifications")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeAccountModificationsResultTypeDef
        print(item)  # (3)

1. client: WorkSpacesClient
2. paginator: DescribeAccountModificationsPaginator
3. item: DescribeAccountModificationsResultTypeDef