CloudHSM module#
Index > CloudHSM
Auto-generated documentation for CloudHSM type annotations stubs module types-aiobotocore-cloudhsm.
How to install#
Generate locally (recommended)#
You can generate type annotations for aioboto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aioboto3==14.1.0' mypy-boto3-builder
- Select
aioboto3
AWS SDK. - Add
CloudHSM
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aioboto3
for CloudHSM
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[cloudhsm]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[cloudhsm]'
# standalone installation
python -m pip install types-aiobotocore-cloudhsm
How to uninstall#
python -m pip uninstall -y types-aiobotocore-cloudhsm
Usage#
Code samples can be found in Examples.
CloudHSMClient#
Type annotations and code completion for session.client("cloudhsm")
as CloudHSMClient
boto3 documentation
# CloudHSMClient usage example
from aioboto3.session import Session
from types_aiobotocore_cloudhsm.client import CloudHSMClient
session = Session()
async with session.client("cloudhsm") as client:
client: CloudHSMClient
Paginators#
Type annotations and code completion for
paginators
from session.client("cloudhsm").get_paginator("...")
.
# ListHapgsPaginator usage example
from types_aiobotocore_cloudhsm.paginator import ListHapgsPaginator
def get_list_hapgs_paginator() -> ListHapgsPaginator:
return client.get_paginator("list_hapgs"))
Literals#
Type annotations for literals used in methods and schema.
# ClientVersionType usage example
from types_aiobotocore_cloudhsm.literals import ClientVersionType
def get_value() -> ClientVersionType:
return "5.1"
- ClientVersionType
- CloudHsmObjectStateType
- HsmStatusType
- ListHapgsPaginatorName
- ListHsmsPaginatorName
- ListLunaClientsPaginatorName
- SubscriptionTypeType
- CloudHSMServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- TagTypeDef
- ResponseMetadataTypeDef
- CreateHapgRequestTypeDef
- CreateHsmRequestTypeDef
- CreateLunaClientRequestTypeDef
- DeleteHapgRequestTypeDef
- DeleteHsmRequestTypeDef
- DeleteLunaClientRequestTypeDef
- DescribeHapgRequestTypeDef
- DescribeHsmRequestTypeDef
- DescribeLunaClientRequestTypeDef
- GetConfigRequestTypeDef
- PaginatorConfigTypeDef
- ListHapgsRequestTypeDef
- ListHsmsRequestTypeDef
- ListLunaClientsRequestTypeDef
- ListTagsForResourceRequestTypeDef
- ModifyHapgRequestTypeDef
- ModifyHsmRequestTypeDef
- ModifyLunaClientRequestTypeDef
- RemoveTagsFromResourceRequestTypeDef
- AddTagsToResourceRequestTypeDef
- AddTagsToResourceResponseTypeDef
- CreateHapgResponseTypeDef
- CreateHsmResponseTypeDef
- CreateLunaClientResponseTypeDef
- DeleteHapgResponseTypeDef
- DeleteHsmResponseTypeDef
- DeleteLunaClientResponseTypeDef
- DescribeHapgResponseTypeDef
- DescribeHsmResponseTypeDef
- DescribeLunaClientResponseTypeDef
- GetConfigResponseTypeDef
- ListAvailableZonesResponseTypeDef
- ListHapgsResponseTypeDef
- ListHsmsResponseTypeDef
- ListLunaClientsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- ModifyHapgResponseTypeDef
- ModifyHsmResponseTypeDef
- ModifyLunaClientResponseTypeDef
- RemoveTagsFromResourceResponseTypeDef
- ListHapgsRequestPaginateTypeDef
- ListHsmsRequestPaginateTypeDef
- ListLunaClientsRequestPaginateTypeDef