ControlCatalog module#
Index > ControlCatalog
Auto-generated documentation for ControlCatalog type annotations stubs module types-aiobotocore-controlcatalog.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.25.0' mypy-boto3-builder
- Select
aiobotocore
AWS SDK. - Add
ControlCatalog
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore
for ControlCatalog
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[controlcatalog]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[controlcatalog]'
# standalone installation
python -m pip install types-aiobotocore-controlcatalog
How to uninstall#
python -m pip uninstall -y types-aiobotocore-controlcatalog
Usage#
Code samples can be found in Examples.
ControlCatalogClient#
Type annotations and code completion for session.create_client("controlcatalog")
as ControlCatalogClient
boto3 documentation
# ControlCatalogClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_controlcatalog.client import ControlCatalogClient
session = get_session()
async with session.create_client("controlcatalog") as client:
client: ControlCatalogClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("controlcatalog").get_paginator("...")
.
# ListCommonControlsPaginator usage example
from types_aiobotocore_controlcatalog.paginator import ListCommonControlsPaginator
def get_list_common_controls_paginator() -> ListCommonControlsPaginator:
return client.get_paginator("list_common_controls"))
- ListCommonControlsPaginator
- ListControlMappingsPaginator
- ListControlsPaginator
- ListDomainsPaginator
- ListObjectivesPaginator
Literals#
Type annotations for literals used in methods and schema.
# ControlBehaviorType usage example
from types_aiobotocore_controlcatalog.literals import ControlBehaviorType
def get_value() -> ControlBehaviorType:
return "DETECTIVE"
- ControlBehaviorType
- ControlScopeType
- ControlSeverityType
- ListCommonControlsPaginatorName
- ListControlMappingsPaginatorName
- ListControlsPaginatorName
- ListDomainsPaginatorName
- ListObjectivesPaginatorName
- MappingTypeType
- ControlCatalogServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AssociatedDomainSummaryTypeDef
- AssociatedObjectiveSummaryTypeDef
- ObjectiveResourceFilterTypeDef
- CommonControlMappingDetailsTypeDef
- ImplementationFilterTypeDef
- ControlMappingFilterTypeDef
- ControlParameterTypeDef
- ImplementationSummaryTypeDef
- DomainResourceFilterTypeDef
- DomainSummaryTypeDef
- FrameworkMappingDetailsTypeDef
- GetControlRequestTypeDef
- ImplementationDetailsTypeDef
- RegionConfigurationTypeDef
- ResponseMetadataTypeDef
- PaginatorConfigTypeDef
- ListDomainsRequestTypeDef
- ObjectiveSummaryTypeDef
- CommonControlSummaryTypeDef
- CommonControlFilterTypeDef
- ControlFilterTypeDef
- ListControlMappingsRequestTypeDef
- ControlSummaryTypeDef
- ObjectiveFilterTypeDef
- MappingTypeDef
- GetControlResponseTypeDef
- ListDomainsResponseTypeDef
- ListControlMappingsRequestPaginateTypeDef
- ListDomainsRequestPaginateTypeDef
- ListObjectivesResponseTypeDef
- ListCommonControlsResponseTypeDef
- ListCommonControlsRequestPaginateTypeDef
- ListCommonControlsRequestTypeDef
- ListControlsRequestPaginateTypeDef
- ListControlsRequestTypeDef
- ListControlsResponseTypeDef
- ListObjectivesRequestPaginateTypeDef
- ListObjectivesRequestTypeDef
- ControlMappingTypeDef
- ListControlMappingsResponseTypeDef