Examples#
Index > OpsWorksCM > Examples
Auto-generated documentation for OpsWorksCM type annotations stubs module types-aiobotocore-opsworkscm.
Client#
Implicit type annotations#
Can be used with types-aioboto3[opsworkscm]
package installed.
Write your OpsWorksCM
code as usual,
type checking and code completion should work out of the box.
# OpsWorksCMClient usage example
from aioboto3.session import Session
session = Session()
async with session.client("opsworkscm") as client: # (1)
result = await client.associate_node() # (2)
- client: OpsWorksCMClient
- result: AssociateNodeResponseTypeDef
# DescribeBackupsPaginator usage example
from aioboto3.session import Session
session = Session()
async with session.client("opsworkscm") as client: # (1)
paginator = client.get_paginator("describe_backups") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: OpsWorksCMClient
- paginator: DescribeBackupsPaginator
- item: DescribeBackupsResponseTypeDef
# NodeAssociatedWaiter usage example
from aioboto3.session import Session
session = Session()
async with session.client("opsworkscm") as client: # (1)
waiter = client.get_waiter("node_associated") # (2)
await waiter.wait()
- client: OpsWorksCMClient
- waiter: NodeAssociatedWaiter
Explicit type annotations#
With types-aioboto3-lite[opsworkscm]
or a standalone types_aiobotocore_opsworkscm
package, you have to explicitly specify
client: OpsWorksCMClient
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.
# OpsWorksCMClient usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_opsworkscm.client import OpsWorksCMClient
from types_aiobotocore_opsworkscm.type_defs import AssociateNodeResponseTypeDef
from types_aiobotocore_opsworkscm.type_defs import AssociateNodeRequestRequestTypeDef
session = Session()
client: OpsWorksCMClient
async with session.client("opsworkscm") as client: # (1)
kwargs: AssociateNodeRequestRequestTypeDef = {...} # (2)
result: AssociateNodeResponseTypeDef = await client.associate_node(**kwargs) # (3)
- client: OpsWorksCMClient
- kwargs: AssociateNodeRequestRequestTypeDef
- result: AssociateNodeResponseTypeDef
# DescribeBackupsPaginator usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_opsworkscm.client import OpsWorksCMClient
from types_aiobotocore_opsworkscm.paginator import DescribeBackupsPaginator
from types_aiobotocore_opsworkscm.type_defs import DescribeBackupsResponseTypeDef
session = Session()
client: OpsWorksCMClient
async with session.client("opsworkscm") as client: # (1)
paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups") # (2)
async for item in paginator.paginate(...):
item: DescribeBackupsResponseTypeDef
print(item) # (3)
- client: OpsWorksCMClient
- paginator: DescribeBackupsPaginator
- item: DescribeBackupsResponseTypeDef
# NodeAssociatedWaiter usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_opsworkscm.client import OpsWorksCMClient
from types_aiobotocore_opsworkscm.waiter import NodeAssociatedWaiter
session = Session()
async with session.client("opsworkscm") as client: # (1)
waiter = client.get_waiter("node_associated") # (2)
await waiter.wait()
- client: OpsWorksCMClient
- waiter: NodeAssociatedWaiter