Skip to content

Examples#

Index > OpsWorks > 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.

Client method usage example#

# OpsWorksClient usage example

from boto3.session import Session


session = Session()

client = session.client("opsworks")  # (1)
result = client.assign_instance()  # (2)
  1. client: OpsWorksClient
  2. result: EmptyResponseMetadataTypeDef

Paginator usage example#

# DescribeEcsClustersPaginator usage example

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)
  1. client: OpsWorksClient
  2. paginator: DescribeEcsClustersPaginator
  3. item: DescribeEcsClustersResultTypeDef

Waiter usage example#

# AppExistsWaiter usage example

from boto3.session import Session


session = Session()
client = session.client("opsworks")  # (1)

waiter = client.get_waiter("app_exists")  # (2)
waiter.wait(...)
  1. client: OpsWorksClient
  2. 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.

Client method usage example#

# OpsWorksClient usage example with type annotations

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 AssignInstanceRequestTypeDef


session = Session()

client: OpsWorksClient = session.client("opsworks")

kwargs: AssignInstanceRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.assign_instance(**kwargs)

Paginator usage example#

# DescribeEcsClustersPaginator usage example with type annotations

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)

Waiter usage example#

# AppExistsWaiter usage example with type annotations

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.

ServiceResource method usage example#

# OpsWorksServiceResource usage example

from boto3.session import Session


session = Session()

resource = session.resource("opsworks")  # (1)
result = resource.create_stack(...)  # (2)
  1. resource: OpsWorksServiceResource
  2. result: Stack

Collection usage example#

# ServiceResourceStacksCollection usage example

from boto3.session import Session


session = Session()
resource = session.resource("opsworks")  # (1)

collection = resource.stacks  # (2)
for item in collection:
    print(item)  # (3)
  1. resource: OpsWorksServiceResource
  2. collection: ServiceResourceStacksCollection
  3. 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.

ServiceResource method usage example#

# OpsWorksServiceResource usage example with type annotations

from boto3.session import Session

from mypy_boto3_opsworks.service_resource import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import Stack
from mypy_boto3_opsworks.type_defs import CreateStackRequestServiceResourceCreateStackTypeDef


session = Session()

resource: OpsWorksServiceResource = session.resource("opsworks")
kwargs: CreateStackRequestServiceResourceCreateStackTypeDef = {...}  # (2)
result: Stack = resource.create_stack(**kwargs)
  1. resource: OpsWorksServiceResource
  2. kwargs: CreateStackRequestServiceResourceCreateStackTypeDef
  3. result: Stack

Collection usage example#

# ServiceResourceStacksCollection usage example with type annotations

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")  # (1)

collection: ServiceResourceStacksCollection = resource.stacks  # (2)
for item in collection:
    item: Stack
    print(item)  # (3)
  1. resource: OpsWorksServiceResource
  2. collection: OpsWorksServiceResource
  3. item: Stack