Typed dictionaries

Index > CloudHSMV2 > Typed dictionaries

Auto-generated documentation for CloudHSMV2 type annotations stubs module mypy-boto3-cloudhsmv2.

BackupRetentionPolicyTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import BackupRetentionPolicyTypeDef

def get_value() -> BackupRetentionPolicyTypeDef:
    return {
        "Type": ...,
    }

Definition

class BackupRetentionPolicyTypeDef(TypedDict):
    Type: NotRequired[BackupRetentionTypeType],  # (1)
    Value: NotRequired[str],

1. See BackupRetentionTypeType

TagTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import TagTypeDef

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

Definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CertificatesTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CertificatesTypeDef

def get_value() -> CertificatesTypeDef:
    return {
        "ClusterCsr": ...,
    }

Definition

class CertificatesTypeDef(TypedDict):
    ClusterCsr: NotRequired[str],
    HsmCertificate: NotRequired[str],
    AwsHardwareCertificate: NotRequired[str],
    ManufacturerHardwareCertificate: NotRequired[str],
    ClusterCertificate: NotRequired[str],

HsmTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import HsmTypeDef

def get_value() -> HsmTypeDef:
    return {
        "HsmId": ...,
    }

Definition

class HsmTypeDef(TypedDict):
    HsmId: str,
    AvailabilityZone: NotRequired[str],
    ClusterId: NotRequired[str],
    SubnetId: NotRequired[str],
    EniId: NotRequired[str],
    EniIp: NotRequired[str],
    State: NotRequired[HsmStateType],  # (1)
    StateMessage: NotRequired[str],

1. See HsmStateType

DestinationBackupTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DestinationBackupTypeDef

def get_value() -> DestinationBackupTypeDef:
    return {
        "CreateTimestamp": ...,
    }

Definition

class DestinationBackupTypeDef(TypedDict):
    CreateTimestamp: NotRequired[datetime],
    SourceRegion: NotRequired[str],
    SourceBackup: NotRequired[str],
    SourceCluster: NotRequired[str],

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateHsmRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CreateHsmRequestRequestTypeDef

def get_value() -> CreateHsmRequestRequestTypeDef:
    return {
        "ClusterId": ...,
        "AvailabilityZone": ...,
    }

Definition

class CreateHsmRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    AvailabilityZone: str,
    IpAddress: NotRequired[str],

DeleteBackupRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DeleteBackupRequestRequestTypeDef

def get_value() -> DeleteBackupRequestRequestTypeDef:
    return {
        "BackupId": ...,
    }

Definition

class DeleteBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,

DeleteClusterRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DeleteClusterRequestRequestTypeDef

def get_value() -> DeleteClusterRequestRequestTypeDef:
    return {
        "ClusterId": ...,
    }

Definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    ClusterId: str,

DeleteHsmRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DeleteHsmRequestRequestTypeDef

def get_value() -> DeleteHsmRequestRequestTypeDef:
    return {
        "ClusterId": ...,
    }

Definition

class DeleteHsmRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    HsmId: NotRequired[str],
    EniId: NotRequired[str],
    EniIp: NotRequired[str],

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeBackupsRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DescribeBackupsRequestRequestTypeDef

def get_value() -> DescribeBackupsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

Definition

class DescribeBackupsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    SortAscending: NotRequired[bool],

DescribeClustersRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DescribeClustersRequestRequestTypeDef

def get_value() -> DescribeClustersRequestRequestTypeDef:
    return {
        "Filters": ...,
    }

Definition

class DescribeClustersRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

InitializeClusterRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import InitializeClusterRequestRequestTypeDef

def get_value() -> InitializeClusterRequestRequestTypeDef:
    return {
        "ClusterId": ...,
        "SignedCert": ...,
        "TrustAnchor": ...,
    }

Definition

class InitializeClusterRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    SignedCert: str,
    TrustAnchor: str,

ListTagsRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ListTagsRequestRequestTypeDef

def get_value() -> ListTagsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }

Definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ModifyBackupAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ModifyBackupAttributesRequestRequestTypeDef

def get_value() -> ModifyBackupAttributesRequestRequestTypeDef:
    return {
        "BackupId": ...,
        "NeverExpires": ...,
    }

Definition

class ModifyBackupAttributesRequestRequestTypeDef(TypedDict):
    BackupId: str,
    NeverExpires: bool,

RestoreBackupRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import RestoreBackupRequestRequestTypeDef

def get_value() -> RestoreBackupRequestRequestTypeDef:
    return {
        "BackupId": ...,
    }

Definition

class RestoreBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "TagKeyList": ...,
    }

Definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    TagKeyList: Sequence[str],

ModifyClusterRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ModifyClusterRequestRequestTypeDef

def get_value() -> ModifyClusterRequestRequestTypeDef:
    return {
        "BackupRetentionPolicy": ...,
        "ClusterId": ...,
    }

Definition

class ModifyClusterRequestRequestTypeDef(TypedDict):
    BackupRetentionPolicy: BackupRetentionPolicyTypeDef,  # (1)
    ClusterId: str,

1. See BackupRetentionPolicyTypeDef

BackupTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import BackupTypeDef

def get_value() -> BackupTypeDef:
    return {
        "BackupId": ...,
    }

Definition

class BackupTypeDef(TypedDict):
    BackupId: str,
    BackupState: NotRequired[BackupStateType],  # (1)
    ClusterId: NotRequired[str],
    CreateTimestamp: NotRequired[datetime],
    CopyTimestamp: NotRequired[datetime],
    NeverExpires: NotRequired[bool],
    SourceRegion: NotRequired[str],
    SourceBackup: NotRequired[str],
    SourceCluster: NotRequired[str],
    DeleteTimestamp: NotRequired[datetime],
    TagList: NotRequired[List[TagTypeDef]],  # (2)

1. See BackupStateType
2. See TagTypeDef

CopyBackupToRegionRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CopyBackupToRegionRequestRequestTypeDef

def get_value() -> CopyBackupToRegionRequestRequestTypeDef:
    return {
        "DestinationRegion": ...,
        "BackupId": ...,
    }

Definition

class CopyBackupToRegionRequestRequestTypeDef(TypedDict):
    DestinationRegion: str,
    BackupId: str,
    TagList: NotRequired[Sequence[TagTypeDef]],  # (1)

1. See TagTypeDef

CreateClusterRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CreateClusterRequestRequestTypeDef

def get_value() -> CreateClusterRequestRequestTypeDef:
    return {
        "HsmType": ...,
        "SubnetIds": ...,
    }

Definition

class CreateClusterRequestRequestTypeDef(TypedDict):
    HsmType: str,
    SubnetIds: Sequence[str],
    BackupRetentionPolicy: NotRequired[BackupRetentionPolicyTypeDef],  # (1)
    SourceBackupId: NotRequired[str],
    TagList: NotRequired[Sequence[TagTypeDef]],  # (2)

1. See BackupRetentionPolicyTypeDef
2. See TagTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "TagList": ...,
    }

Definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    TagList: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

ClusterTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ClusterTypeDef

def get_value() -> ClusterTypeDef:
    return {
        "BackupPolicy": ...,
    }

Definition

class ClusterTypeDef(TypedDict):
    BackupPolicy: NotRequired[BackupPolicyType],  # (1)
    BackupRetentionPolicy: NotRequired[BackupRetentionPolicyTypeDef],  # (2)
    ClusterId: NotRequired[str],
    CreateTimestamp: NotRequired[datetime],
    Hsms: NotRequired[List[HsmTypeDef]],  # (3)
    HsmType: NotRequired[str],
    PreCoPassword: NotRequired[str],
    SecurityGroup: NotRequired[str],
    SourceBackupId: NotRequired[str],
    State: NotRequired[ClusterStateType],  # (4)
    StateMessage: NotRequired[str],
    SubnetMapping: NotRequired[Dict[str, str]],
    VpcId: NotRequired[str],
    Certificates: NotRequired[CertificatesTypeDef],  # (5)
    TagList: NotRequired[List[TagTypeDef]],  # (6)

1. See BackupPolicyType
2. See BackupRetentionPolicyTypeDef
3. See HsmTypeDef
4. See ClusterStateType
5. See CertificatesTypeDef
6. See TagTypeDef

CopyBackupToRegionResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CopyBackupToRegionResponseTypeDef

def get_value() -> CopyBackupToRegionResponseTypeDef:
    return {
        "DestinationBackup": ...,
        "ResponseMetadata": ...,
    }

Definition

class CopyBackupToRegionResponseTypeDef(TypedDict):
    DestinationBackup: DestinationBackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DestinationBackupTypeDef
2. See ResponseMetadataTypeDef

CreateHsmResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CreateHsmResponseTypeDef

def get_value() -> CreateHsmResponseTypeDef:
    return {
        "Hsm": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateHsmResponseTypeDef(TypedDict):
    Hsm: HsmTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See HsmTypeDef
2. See ResponseMetadataTypeDef

DeleteHsmResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DeleteHsmResponseTypeDef

def get_value() -> DeleteHsmResponseTypeDef:
    return {
        "HsmId": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteHsmResponseTypeDef(TypedDict):
    HsmId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

InitializeClusterResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import InitializeClusterResponseTypeDef

def get_value() -> InitializeClusterResponseTypeDef:
    return {
        "State": ...,
        "StateMessage": ...,
        "ResponseMetadata": ...,
    }

Definition

class InitializeClusterResponseTypeDef(TypedDict):
    State: ClusterStateType,  # (1)
    StateMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ClusterStateType
2. See ResponseMetadataTypeDef

ListTagsResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ListTagsResponseTypeDef

def get_value() -> ListTagsResponseTypeDef:
    return {
        "TagList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsResponseTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagTypeDef
2. See ResponseMetadataTypeDef

DescribeBackupsRequestDescribeBackupsPaginateTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DescribeBackupsRequestDescribeBackupsPaginateTypeDef

def get_value() -> DescribeBackupsRequestDescribeBackupsPaginateTypeDef:
    return {
        "Filters": ...,
    }

Definition

class DescribeBackupsRequestDescribeBackupsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    SortAscending: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeClustersRequestDescribeClustersPaginateTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DescribeClustersRequestDescribeClustersPaginateTypeDef

def get_value() -> DescribeClustersRequestDescribeClustersPaginateTypeDef:
    return {
        "Filters": ...,
    }

Definition

class DescribeClustersRequestDescribeClustersPaginateTypeDef(TypedDict):
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListTagsRequestListTagsPaginateTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ListTagsRequestListTagsPaginateTypeDef

def get_value() -> ListTagsRequestListTagsPaginateTypeDef:
    return {
        "ResourceId": ...,
    }

Definition

class ListTagsRequestListTagsPaginateTypeDef(TypedDict):
    ResourceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DeleteBackupResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DeleteBackupResponseTypeDef

def get_value() -> DeleteBackupResponseTypeDef:
    return {
        "Backup": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BackupTypeDef
2. See ResponseMetadataTypeDef

DescribeBackupsResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DescribeBackupsResponseTypeDef

def get_value() -> DescribeBackupsResponseTypeDef:
    return {
        "Backups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeBackupsResponseTypeDef(TypedDict):
    Backups: List[BackupTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BackupTypeDef
2. See ResponseMetadataTypeDef

ModifyBackupAttributesResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ModifyBackupAttributesResponseTypeDef

def get_value() -> ModifyBackupAttributesResponseTypeDef:
    return {
        "Backup": ...,
        "ResponseMetadata": ...,
    }

Definition

class ModifyBackupAttributesResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BackupTypeDef
2. See ResponseMetadataTypeDef

RestoreBackupResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import RestoreBackupResponseTypeDef

def get_value() -> RestoreBackupResponseTypeDef:
    return {
        "Backup": ...,
        "ResponseMetadata": ...,
    }

Definition

class RestoreBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BackupTypeDef
2. See ResponseMetadataTypeDef

CreateClusterResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import CreateClusterResponseTypeDef

def get_value() -> CreateClusterResponseTypeDef:
    return {
        "Cluster": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ClusterTypeDef
2. See ResponseMetadataTypeDef

DeleteClusterResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DeleteClusterResponseTypeDef

def get_value() -> DeleteClusterResponseTypeDef:
    return {
        "Cluster": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ClusterTypeDef
2. See ResponseMetadataTypeDef

DescribeClustersResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import DescribeClustersResponseTypeDef

def get_value() -> DescribeClustersResponseTypeDef:
    return {
        "Clusters": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeClustersResponseTypeDef(TypedDict):
    Clusters: List[ClusterTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ClusterTypeDef
2. See ResponseMetadataTypeDef

ModifyClusterResponseTypeDef

Usage Example

from mypy_boto3_cloudhsmv2.type_defs import ModifyClusterResponseTypeDef

def get_value() -> ModifyClusterResponseTypeDef:
    return {
        "Cluster": ...,
        "ResponseMetadata": ...,
    }

Definition

class ModifyClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ClusterTypeDef
2. See ResponseMetadataTypeDef