Skip to content

CloudControlApi module#

Index > CloudControlApi

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

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CloudControlApi.

From PyPI with pip#

Install boto3-stubs for CloudControlApi service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudcontrol]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudcontrol]'

# standalone installation
python -m pip install mypy-boto3-cloudcontrol

How to uninstall#

python -m pip uninstall -y mypy-boto3-cloudcontrol


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("cloudcontrol") as CloudControlApiClient boto3 documentation

# CloudControlApiClient usage example

from boto3.session import Session

from mypy_boto3_cloudcontrol.client import CloudControlApiClient

def get_client() -> CloudControlApiClient:
    return Session().client("cloudcontrol")


Type annotations and code completion for paginators from boto3.client("cloudcontrol").get_paginator("...").

# ListResourceRequestsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudcontrol.paginator import ListResourceRequestsPaginator

def get_list_resource_requests_paginator() -> ListResourceRequestsPaginator:
    return Session().client("cloudcontrol").get_paginator("list_resource_requests"))


Type annotations and code completion for waiters from boto3.client("cloudcontrol").get_waiter("...").

# ResourceRequestSuccessWaiter usage example

from boto3.session import Session

from mypy_boto3_cloudcontrol.waiter import ResourceRequestSuccessWaiter

def get_resource_request_success_waiter() -> ResourceRequestSuccessWaiter:
    return Session().client("cloudcontrol").get_waiter("resource_request_success")


Type annotations for literals used in methods and schemas.

# HandlerErrorCodeType usage example

from mypy_boto3_cloudcontrol.literals import HandlerErrorCodeType

def get_value() -> HandlerErrorCodeType:
    return "AccessDenied"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# CancelResourceRequestInputRequestTypeDef usage example

from mypy_boto3_cloudcontrol.type_defs import CancelResourceRequestInputRequestTypeDef

def get_value() -> CancelResourceRequestInputRequestTypeDef:
    return {
        "RequestToken": ...,