Examples

Index > OpsWorks > Examples

Auto-generated documentation for OpsWorks type annotations stubs module types-aiobotocore-opsworks.

Client

Implicit type annotations

Can be used with types-aiobotocore[opsworks] package installed.

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

# OpsWorksClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("opsworks") as client:  # (1)
    result = await client.assign_instance()  # (2)

1. client: OpsWorksClient
2. result: EmptyResponseMetadataTypeDef

# DescribeEcsClustersPaginator usage example

from aiobotocore.session import get_session


session = get_session()

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

1. client: OpsWorksClient
2. paginator: DescribeEcsClustersPaginator
3. item: DescribeEcsClustersResultTypeDef

# AppExistsWaiter usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("opsworks") as client:  # (1)
    waiter = client.get_waiter("app_exists")  # (2)
    await waiter.wait()

1. client: OpsWorksClient
2. waiter: AppExistsWaiter

Explicit type annotations

With types-aiobotocore-lite[opsworks] or a standalone types_aiobotocore_opsworks package, you have to explicitly specify client: OpsWorksClient 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.

# OpsWorksClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_opsworks.client import OpsWorksClient
from types_aiobotocore_opsworks.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_opsworks.type_defs import AssignInstanceRequestRequestTypeDef


session = get_session()

async with session.create_client("opsworks") as client:
    client: OpsWorksClient
    kwargs: AssignInstanceRequestRequestTypeDef = {...}
    result: EmptyResponseMetadataTypeDef = await client.assign_instance(**kwargs)

# DescribeEcsClustersPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_opsworks.client import OpsWorksClient
from types_aiobotocore_opsworks.paginator import DescribeEcsClustersPaginator
from types_aiobotocore_opsworks.type_defs import DescribeEcsClustersResultTypeDef


session = get_session()

async with session.create_client("opsworks") as client:
    client: OpsWorksClient
    paginator: DescribeEcsClustersPaginator = client.get_paginator("describe_ecs_clusters")
    async for item in paginator.paginate(...):
        item: DescribeEcsClustersResultTypeDef
        print(item)

# AppExistsWaiter usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_opsworks.client import OpsWorksClient
from types_aiobotocore_opsworks.waiter import AppExistsWaiter


session = get_session()

async with session.create_client("opsworks") as client:
    client: OpsWorksClient
    waiter: AppExistsWaiter = client.get_waiter("app_exists")
    await waiter.wait()