Examples

Index > CloudControlApi > Examples

Auto-generated documentation for CloudControlApi type annotations stubs module mypy-boto3-cloudcontrol.

Client

Implicit type annotations

Can be used with boto3-stubs[cloudcontrol] package installed.

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

# CloudControlApiClient usage example

from boto3.session import Session


session = Session()

client = session.client("cloudcontrol")  # (1)
result = client.cancel_resource_request()  # (2)

1. client: CloudControlApiClient
2. result: CancelResourceRequestOutputTypeDef

# ListResourceRequestsPaginator usage example

from boto3.session import Session


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

paginator = client.get_paginator("list_resource_requests")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: CloudControlApiClient
2. paginator: ListResourceRequestsPaginator
3. item: ListResourceRequestsOutputTypeDef

# ResourceRequestSuccessWaiter usage example

from boto3.session import Session


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

waiter = client.get_waiter("resource_request_success")  # (2)
waiter.wait()

1. client: CloudControlApiClient
2. waiter: ResourceRequestSuccessWaiter

Explicit type annotations

With boto3-stubs-lite[cloudcontrol] or a standalone mypy_boto3_cloudcontrol package, you have to explicitly specify client: CloudControlApiClient 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.

# CloudControlApiClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudcontrol.client import CloudControlApiClient
from mypy_boto3_cloudcontrol.type_defs import CancelResourceRequestOutputTypeDef
from mypy_boto3_cloudcontrol.type_defs import CancelResourceRequestInputRequestTypeDef


session = Session()

client: CloudControlApiClient = session.client("cloudcontrol")

kwargs: CancelResourceRequestInputRequestTypeDef = {...}
result: CancelResourceRequestOutputTypeDef = client.cancel_resource_request(**kwargs)

# ListResourceRequestsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudcontrol.client import CloudControlApiClient
from mypy_boto3_cloudcontrol.paginator import ListResourceRequestsPaginator
from mypy_boto3_cloudcontrol.type_defs import ListResourceRequestsOutputTypeDef


session = Session()
client: CloudControlApiClient = session.client("cloudcontrol")

paginator: ListResourceRequestsPaginator = client.get_paginator("list_resource_requests")
for item in paginator.paginate(...):
    item: ListResourceRequestsOutputTypeDef
    print(item)

# ResourceRequestSuccessWaiter usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudcontrol.client import CloudControlApiClient
from mypy_boto3_cloudcontrol.waiter import ResourceRequestSuccessWaiter

session = Session()
client: CloudControlApiClient = session.client("cloudcontrol")

waiter: ResourceRequestSuccessWaiter = client.get_waiter("resource_request_success")
waiter.wait()