CloudHSMV2 module#
Index > CloudHSMV2
Auto-generated documentation for CloudHSMV2 type annotations stubs module mypy-boto3-cloudhsmv2.
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 CloudHSMV2
.
From PyPI with pip#
Install boto3-stubs
for CloudHSMV2
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudhsmv2]'
# 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[cloudhsmv2]'
# standalone installation
python -m pip install mypy-boto3-cloudhsmv2
How to uninstall#
python -m pip uninstall -y mypy-boto3-cloudhsmv2
Usage#
Code samples can be found in Examples.
CloudHSMV2Client#
Type annotations and code completion for boto3.client("cloudhsmv2")
as CloudHSMV2Client
boto3 documentation
# CloudHSMV2Client usage example
from boto3.session import Session
from mypy_boto3_cloudhsmv2.client import CloudHSMV2Client
def get_client() -> CloudHSMV2Client:
return Session().client("cloudhsmv2")
Paginators#
Type annotations and code completion for paginators
from boto3.client("cloudhsmv2").get_paginator("...")
.
# DescribeBackupsPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudhsmv2.paginator import DescribeBackupsPaginator
def get_describe_backups_paginator() -> DescribeBackupsPaginator:
return Session().client("cloudhsmv2").get_paginator("describe_backups"))
Literals#
Type annotations for literals used in methods and schema.
# BackupPolicyType usage example
from mypy_boto3_cloudhsmv2.literals import BackupPolicyType
def get_value() -> BackupPolicyType:
return "DEFAULT"
- BackupPolicyType
- BackupRetentionTypeType
- BackupStateType
- ClusterModeType
- ClusterStateType
- DescribeBackupsPaginatorName
- DescribeClustersPaginatorName
- HsmStateType
- ListTagsPaginatorName
- CloudHSMV2ServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BackupRetentionPolicyTypeDef
- TagTypeDef
- CertificatesTypeDef
- HsmTypeDef
- DestinationBackupTypeDef
- ResponseMetadataTypeDef
- CreateHsmRequestRequestTypeDef
- DeleteBackupRequestRequestTypeDef
- DeleteClusterRequestRequestTypeDef
- DeleteHsmRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeBackupsRequestRequestTypeDef
- DescribeClustersRequestRequestTypeDef
- GetResourcePolicyRequestRequestTypeDef
- InitializeClusterRequestRequestTypeDef
- ListTagsRequestRequestTypeDef
- ModifyBackupAttributesRequestRequestTypeDef
- PutResourcePolicyRequestRequestTypeDef
- RestoreBackupRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- ModifyClusterRequestRequestTypeDef
- BackupTypeDef
- CopyBackupToRegionRequestRequestTypeDef
- CreateClusterRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- ClusterTypeDef
- CopyBackupToRegionResponseTypeDef
- CreateHsmResponseTypeDef
- DeleteHsmResponseTypeDef
- DeleteResourcePolicyResponseTypeDef
- GetResourcePolicyResponseTypeDef
- InitializeClusterResponseTypeDef
- ListTagsResponseTypeDef
- PutResourcePolicyResponseTypeDef
- DescribeBackupsRequestDescribeBackupsPaginateTypeDef
- DescribeClustersRequestDescribeClustersPaginateTypeDef
- ListTagsRequestListTagsPaginateTypeDef
- DeleteBackupResponseTypeDef
- DescribeBackupsResponseTypeDef
- ModifyBackupAttributesResponseTypeDef
- RestoreBackupResponseTypeDef
- CreateClusterResponseTypeDef
- DeleteClusterResponseTypeDef
- DescribeClustersResponseTypeDef
- ModifyClusterResponseTypeDef