Skip to main content

types-aiobotocore-cloudhsm

PyPI - types-aiobotocore-cloudhsm PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore CloudHSM 3.9.2 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on types-aiobotocore page and in types-aiobotocore-cloudhsm docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==3.9.2' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add CloudHSM service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for CloudHSM service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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-aiobotocore-lite[cloudhsm]'

# standalone installation
python -m pip install types-aiobotocore-cloudhsm

How to uninstall

python -m pip uninstall -y types-aiobotocore-cloudhsm

Usage

VSCode

python -m pip install 'types-aiobotocore[cloudhsm]'

Both type checking and code completion should now work. No explicit type annotations required, write your aiobotocore code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-aiobotocore-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace types-aiobotocore with types-aiobotocore-lite:

pip uninstall types-aiobotocore
pip install types-aiobotocore-lite

Install types-aiobotocore[cloudhsm] in your environment:

python -m pip install 'types-aiobotocore[cloudhsm]'

Both type checking and code completion should now work.

Emacs

  • Install types-aiobotocore with services you use in your environment:
python -m pip install 'types-aiobotocore[cloudhsm]'
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed types-aiobotocore

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Sublime Text

  • Install types-aiobotocore[cloudhsm] with services you use in your environment:
python -m pip install 'types-aiobotocore[cloudhsm]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install types-aiobotocore[cloudhsm] in your environment:
python -m pip install 'types-aiobotocore[cloudhsm]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install types-aiobotocore[cloudhsm] in your environment:
python -m pip install 'types-aiobotocore[cloudhsm]'

Optionally, you can install types-aiobotocore to typings directory.

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-aiobotocore-cloudhsm dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
    from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
    from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

CloudHSMClient provides annotations for session.create_client("cloudhsm").

from aiobotocore.session import get_session

from types_aiobotocore_cloudhsm import CloudHSMClient

session = get_session()
async with session.create_client("cloudhsm") as client:
    client: CloudHSMClient
    # now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

types_aiobotocore_cloudhsm.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_cloudhsm import CloudHSMClient
from types_aiobotocore_cloudhsm.paginator import (
    ListHapgsPaginator,
    ListHsmsPaginator,
    ListLunaClientsPaginator,
)

session = get_session()
async with session.create_client("cloudhsm") as client:
    client: CloudHSMClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_hapgs_paginator: ListHapgsPaginator = client.get_paginator("list_hapgs")
    list_hsms_paginator: ListHsmsPaginator = client.get_paginator("list_hsms")
    list_luna_clients_paginator: ListLunaClientsPaginator = client.get_paginator(
        "list_luna_clients"
    )

Literals

types_aiobotocore_cloudhsm.literals module contains literals extracted from shapes that can be used in user code for type checking.

Full list of CloudHSM Literals can be found in docs.

from types_aiobotocore_cloudhsm.literals import ClientVersionType


def check_value(value: ClientVersionType) -> bool: ...

Type definitions

types_aiobotocore_cloudhsm.type_defs module contains structures and shapes assembled to typed dictionaries and unions for additional type checking.

Full list of CloudHSM TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_cloudhsm.type_defs import TagTypeDef


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

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers drop-in type annotations for you and makes sure that:

  • All available aiobotocore services are covered.
  • Each public class and method of every aiobotocore service gets valid type annotations extracted from botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.resource calls
  • Auto discovery of types for session.client and session.resource calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

types-aiobotocore-cloudhsm version is the same as related aiobotocore version and follows Python Packaging version specifiers.

Thank you

Documentation

All services type annotations can be found in aiobotocore docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Metadata

Release files for types-aiobotocore-cloudhsm 3.9.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for types-aiobotocore-cloudhsm 3.9.2
File Size Uploaded
types_aiobotocore_cloudhsm-3.9.2.tar.gz 18.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for types-aiobotocore-cloudhsm 3.9.2
File Interpreter ABI Platform
types_aiobotocore_cloudhsm-3.9.2-py3-none-any.whl Python 3 none any Details

Total release size: 43.1 kB

Release files / types_aiobotocore_cloudhsm-3.9.2.tar.gz

Download URL types_aiobotocore_cloudhsm-3.9.2.tar.gz
Size 18.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d32744c0fad881b0b2ad2711a5e21ac5c2e0769d7a04a3339d9e446965608b67
BLAKE2b-256 checksum
How to use checksums
72df44fb42fc8ebdf2c2609f05b5d938e78055fdbaabad04480f0473fb543a70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Release files / types_aiobotocore_cloudhsm-3.9.2-py3-none-any.whl

Download URL types_aiobotocore_cloudhsm-3.9.2-py3-none-any.whl
Size 24.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
feb5fddc126a84fe4ff957972b259de6d0e910fac2d41fb02b0fd142be335184
BLAKE2b-256 checksum
How to use checksums
7d4c76c06bf03ed9e40803da883cb9688855184e015f88a41d7b2bed06bbf453
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Release history Release notifications | RSS feed

This release

3.9.2 This release

2 release files

3.9.1

2 release files

3.9.0

2 release files

3.8.0

2 release files

3.7.0

2 release files

3.6.0

2 release files

3.5.0

2 release files

3.4.0

2 release files

3.3.0

2 release files

3.2.1

2 release files

3.2.0

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.26.0

2 release files

2.25.2

2 release files

2.25.1

2 release files

2.25.0

2 release files

2.24.1

2 release files

2.23.2

2 release files

2.23.1

2 release files

2.23.0

2 release files

2.20.0

2 release files

2.19.0

2 release files

2.18.0

2 release files

2.16.1

2 release files

2.16.0

2 release files

2.15.2

2 release files

2.15.1

2 release files

2.15.0

2 release files

2.14.0

2 release files

2.13.3

2 release files

2.13.2

2 release files

2.13.1

2 release files

2.13.0

2 release files

2.12.3

2 release files

2.12.0

2 release files

2.11.1

2 release files

2.11.0

2 release files

2.9.1

2 release files

2.9.0

2 release files

2.8.0

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.4

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.4

2 release files

2.3.3

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page