Skip to content

CloudHSM module#

Index > CloudHSM

Auto-generated documentation for CloudHSM type annotations stubs module mypy-boto3-cloudhsm.

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 CloudHSM.

From PyPI with pip#

Install boto3-stubs for CloudHSM service.

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


# 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[cloudhsm]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CloudHSMClient#

Type annotations and code completion for boto3.client("cloudhsm") as CloudHSMClient boto3 documentation

# CloudHSMClient usage example

from boto3.session import Session

from mypy_boto3_cloudhsm.client import CloudHSMClient

def get_client() -> CloudHSMClient:
    return Session().client("cloudhsm")

Paginators#

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

# ListHapgsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudhsm.paginator import ListHapgsPaginator

def get_list_hapgs_paginator() -> ListHapgsPaginator:
    return Session().client("cloudhsm").get_paginator("list_hapgs"))

Literals#

Type annotations for literals used in methods and schemas.

# ClientVersionType usage example

from mypy_boto3_cloudhsm.literals import ClientVersionType

def get_value() -> ClientVersionType:
    return "5.1"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# TagTypeDef usage example

from mypy_boto3_cloudhsm.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }