Examples
Auto-generated documentation for OpsWorks type annotations stubs module mypy-boto3-opsworks.
Client
Implicit type annotations
Can be used with boto3-stubs[opsworks]
package installed.
Write your OpsWorks
code as usual,
type checking and code completion should work out of the box.
from boto3.session import Session
session = Session()
client = session.client("opsworks") # (1)
result = client.assign_instance() # (2)
- client: OpsWorksClient
- result: EmptyResponseMetadataTypeDef
from boto3.session import Session
session = Session()
client = session.client("opsworks") # (1)
paginator = client.get_paginator("describe_ecs_clusters") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: OpsWorksClient
- paginator: DescribeEcsClustersPaginator
- item: DescribeEcsClustersResultTypeDef
from boto3.session import Session
session = Session()
client = session.client("opsworks") # (1)
waiter = client.get_waiter("app_exists") # (2)
waiter.wait()
- client: OpsWorksClient
- waiter: AppExistsWaiter
Explicit type annotations
With boto3-stubs-lite[opsworks]
or a standalone mypy_boto3_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.
from boto3.session import Session
from mypy_boto3_opsworks.client import OpsWorksClient
from mypy_boto3_opsworks.type_defs import EmptyResponseMetadataTypeDef
from mypy_boto3_opsworks.type_defs import AssignInstanceRequestRequestTypeDef
session = Session()
client: OpsWorksClient = session.client("opsworks")
kwargs: AssignInstanceRequestRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.assign_instance(**kwargs)
from boto3.session import Session
from mypy_boto3_opsworks.client import OpsWorksClient
from mypy_boto3_opsworks.paginator import DescribeEcsClustersPaginator
from mypy_boto3_opsworks.type_defs import DescribeEcsClustersResultTypeDef
session = Session()
client: OpsWorksClient = session.client("opsworks")
paginator: DescribeEcsClustersPaginator = client.get_paginator("describe_ecs_clusters")
for item in paginator.paginate(...):
item: DescribeEcsClustersResultTypeDef
print(item)
from boto3.session import Session
from mypy_boto3_opsworks.client import OpsWorksClient
from mypy_boto3_opsworks.waiter import AppExistsWaiter
session = Session()
client: OpsWorksClient = session.client("opsworks")
waiter: AppExistsWaiter = client.get_waiter("app_exists")
waiter.wait()
Service Resource
Implicit type annotations
Can be used with boto3-stubs[opsworks]
package installed.
from boto3.session import Session
session = Session()
resource = session.resource("opsworks") # (1)
result = resource.Layer() # (2)
- resource: OpsWorksServiceResource
- result:
from boto3.session import Session
session = Session()
resource = session.resource("opsworks") # (1)
collection = resource.stacks # (2)
for item in collection:
print(item) # (3)
- resource: OpsWorksServiceResource
- collection: OpsWorksServiceResource
- item: Stack
Explicit type annotations
With boto3-stubs-lite[opsworks]
or a standalone mypy_boto3_opsworks
package, you have to explicitly specify
resource: OpsWorksServiceResource
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.
from boto3.session import Session
from mypy_boto3_opsworks.service_resource import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import Layer
session = Session()
resource: OpsWorksServiceResource = session.resource("opsworks")
result: Layer = resource.Layer()
from boto3.session import Session
from mypy_boto3_opsworks.service_resource import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import ServiceResourceStacksCollection
from mypy_boto3_opsworks.service_resource import Stack
session = Session()
resource: OpsWorksServiceResource = session.resource("opsworks")
collection: ServiceResourceStacksCollection = resource.stacks
for item in collection:
item: Stack
print(item)