ControlCatalog module#
Index > ControlCatalog
Auto-generated documentation for ControlCatalog type annotations stubs module mypy-boto3-controlcatalog.
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 ControlCatalog
.
From PyPI with pip#
Install boto3-stubs
for ControlCatalog
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[controlcatalog]'
# 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[controlcatalog]'
# standalone installation
python -m pip install mypy-boto3-controlcatalog
How to uninstall#
python -m pip uninstall -y mypy-boto3-controlcatalog
Usage#
Code samples can be found in Examples.
ControlCatalogClient#
Type annotations and code completion for boto3.client("controlcatalog")
as ControlCatalogClient
boto3 documentation
# ControlCatalogClient usage example
from boto3.session import Session
from mypy_boto3_controlcatalog.client import ControlCatalogClient
def get_client() -> ControlCatalogClient:
return Session().client("controlcatalog")
Paginators#
Type annotations and code completion for paginators
from boto3.client("controlcatalog").get_paginator("...")
.
# ListCommonControlsPaginator usage example
from boto3.session import Session
from mypy_boto3_controlcatalog.paginator import ListCommonControlsPaginator
def get_list_common_controls_paginator() -> ListCommonControlsPaginator:
return Session().client("controlcatalog").get_paginator("list_common_controls"))
Literals#
Type annotations for literals used in methods and schema.
# ControlBehaviorType usage example
from mypy_boto3_controlcatalog.literals import ControlBehaviorType
def get_value() -> ControlBehaviorType:
return "DETECTIVE"
- ControlBehaviorType
- ControlScopeType
- ListCommonControlsPaginatorName
- ListControlsPaginatorName
- ListDomainsPaginatorName
- ListObjectivesPaginatorName
- ControlCatalogServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AssociatedDomainSummaryTypeDef
- AssociatedObjectiveSummaryTypeDef
- ObjectiveResourceFilterTypeDef
- ControlSummaryTypeDef
- DomainResourceFilterTypeDef
- DomainSummaryTypeDef
- GetControlRequestRequestTypeDef
- RegionConfigurationTypeDef
- ResponseMetadataTypeDef
- PaginatorConfigTypeDef
- ListControlsRequestRequestTypeDef
- ListDomainsRequestRequestTypeDef
- ObjectiveSummaryTypeDef
- CommonControlSummaryTypeDef
- CommonControlFilterTypeDef
- ObjectiveFilterTypeDef
- GetControlResponseTypeDef
- ListControlsResponseTypeDef
- ListDomainsResponseTypeDef
- ListControlsRequestListControlsPaginateTypeDef
- ListDomainsRequestListDomainsPaginateTypeDef
- ListObjectivesResponseTypeDef
- ListCommonControlsResponseTypeDef
- ListCommonControlsRequestListCommonControlsPaginateTypeDef
- ListCommonControlsRequestRequestTypeDef
- ListObjectivesRequestListObjectivesPaginateTypeDef
- ListObjectivesRequestRequestTypeDef