Typed dictionaries

Index > CloudHSM > Typed dictionaries

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

TagTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import TagTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_cloudhsm.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,

CreateHapgRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import CreateHapgRequestRequestTypeDef

def get_value() -> CreateHapgRequestRequestTypeDef:
    return {
        "Label": ...,
    }

Definition

class CreateHapgRequestRequestTypeDef(TypedDict):
    Label: str,

CreateHsmRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import CreateHsmRequestRequestTypeDef

def get_value() -> CreateHsmRequestRequestTypeDef:
    return {
        "SubnetId": ...,
        "SshKey": ...,
        "IamRoleArn": ...,
        "SubscriptionType": ...,
    }

Definition

class CreateHsmRequestRequestTypeDef(TypedDict):
    SubnetId: str,
    SshKey: str,
    IamRoleArn: str,
    SubscriptionType: SubscriptionTypeType,  # (1)
    EniIp: NotRequired[str],
    ExternalId: NotRequired[str],
    ClientToken: NotRequired[str],
    SyslogIp: NotRequired[str],

1. See SubscriptionTypeType

CreateLunaClientRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import CreateLunaClientRequestRequestTypeDef

def get_value() -> CreateLunaClientRequestRequestTypeDef:
    return {
        "Certificate": ...,
    }

Definition

class CreateLunaClientRequestRequestTypeDef(TypedDict):
    Certificate: str,
    Label: NotRequired[str],

DeleteHapgRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DeleteHapgRequestRequestTypeDef

def get_value() -> DeleteHapgRequestRequestTypeDef:
    return {
        "HapgArn": ...,
    }

Definition

class DeleteHapgRequestRequestTypeDef(TypedDict):
    HapgArn: str,

DeleteHsmRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DeleteHsmRequestRequestTypeDef

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

Definition

class DeleteHsmRequestRequestTypeDef(TypedDict):
    HsmArn: str,

DeleteLunaClientRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DeleteLunaClientRequestRequestTypeDef

def get_value() -> DeleteLunaClientRequestRequestTypeDef:
    return {
        "ClientArn": ...,
    }

Definition

class DeleteLunaClientRequestRequestTypeDef(TypedDict):
    ClientArn: str,

DescribeHapgRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DescribeHapgRequestRequestTypeDef

def get_value() -> DescribeHapgRequestRequestTypeDef:
    return {
        "HapgArn": ...,
    }

Definition

class DescribeHapgRequestRequestTypeDef(TypedDict):
    HapgArn: str,

DescribeHsmRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DescribeHsmRequestRequestTypeDef

def get_value() -> DescribeHsmRequestRequestTypeDef:
    return {
        "HsmArn": ...,
    }

Definition

class DescribeHsmRequestRequestTypeDef(TypedDict):
    HsmArn: NotRequired[str],
    HsmSerialNumber: NotRequired[str],

DescribeLunaClientRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DescribeLunaClientRequestRequestTypeDef

def get_value() -> DescribeLunaClientRequestRequestTypeDef:
    return {
        "ClientArn": ...,
    }

Definition

class DescribeLunaClientRequestRequestTypeDef(TypedDict):
    ClientArn: NotRequired[str],
    CertificateFingerprint: NotRequired[str],

GetConfigRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import GetConfigRequestRequestTypeDef

def get_value() -> GetConfigRequestRequestTypeDef:
    return {
        "ClientArn": ...,
        "ClientVersion": ...,
        "HapgList": ...,
    }

Definition

class GetConfigRequestRequestTypeDef(TypedDict):
    ClientArn: str,
    ClientVersion: ClientVersionType,  # (1)
    HapgList: Sequence[str],

1. See ClientVersionType

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import PaginatorConfigTypeDef

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

Definition

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

ListHapgsRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListHapgsRequestRequestTypeDef

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

Definition

class ListHapgsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ListHsmsRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListHsmsRequestRequestTypeDef

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

Definition

class ListHsmsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ListLunaClientsRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListLunaClientsRequestRequestTypeDef

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

Definition

class ListLunaClientsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ModifyHapgRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ModifyHapgRequestRequestTypeDef

def get_value() -> ModifyHapgRequestRequestTypeDef:
    return {
        "HapgArn": ...,
    }

Definition

class ModifyHapgRequestRequestTypeDef(TypedDict):
    HapgArn: str,
    Label: NotRequired[str],
    PartitionSerialList: NotRequired[Sequence[str]],

ModifyHsmRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ModifyHsmRequestRequestTypeDef

def get_value() -> ModifyHsmRequestRequestTypeDef:
    return {
        "HsmArn": ...,
    }

Definition

class ModifyHsmRequestRequestTypeDef(TypedDict):
    HsmArn: str,
    SubnetId: NotRequired[str],
    EniIp: NotRequired[str],
    IamRoleArn: NotRequired[str],
    ExternalId: NotRequired[str],
    SyslogIp: NotRequired[str],

ModifyLunaClientRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ModifyLunaClientRequestRequestTypeDef

def get_value() -> ModifyLunaClientRequestRequestTypeDef:
    return {
        "ClientArn": ...,
        "Certificate": ...,
    }

Definition

class ModifyLunaClientRequestRequestTypeDef(TypedDict):
    ClientArn: str,
    Certificate: str,

RemoveTagsFromResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import RemoveTagsFromResourceRequestRequestTypeDef

def get_value() -> RemoveTagsFromResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeyList": ...,
    }

Definition

class RemoveTagsFromResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeyList: Sequence[str],

AddTagsToResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import AddTagsToResourceRequestRequestTypeDef

def get_value() -> AddTagsToResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagList": ...,
    }

Definition

class AddTagsToResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagList: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

AddTagsToResourceResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import AddTagsToResourceResponseTypeDef

def get_value() -> AddTagsToResourceResponseTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }

Definition

class AddTagsToResourceResponseTypeDef(TypedDict):
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateHapgResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import CreateHapgResponseTypeDef

def get_value() -> CreateHapgResponseTypeDef:
    return {
        "HapgArn": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateHapgResponseTypeDef(TypedDict):
    HapgArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateHsmResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import CreateHsmResponseTypeDef

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

Definition

class CreateHsmResponseTypeDef(TypedDict):
    HsmArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateLunaClientResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import CreateLunaClientResponseTypeDef

def get_value() -> CreateLunaClientResponseTypeDef:
    return {
        "ClientArn": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateLunaClientResponseTypeDef(TypedDict):
    ClientArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

DeleteHapgResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DeleteHapgResponseTypeDef

def get_value() -> DeleteHapgResponseTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteHapgResponseTypeDef(TypedDict):
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

DeleteHsmResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DeleteHsmResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

DeleteLunaClientResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DeleteLunaClientResponseTypeDef

def get_value() -> DeleteLunaClientResponseTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteLunaClientResponseTypeDef(TypedDict):
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

DescribeHapgResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DescribeHapgResponseTypeDef

def get_value() -> DescribeHapgResponseTypeDef:
    return {
        "HapgArn": ...,
        "HapgSerial": ...,
        "HsmsLastActionFailed": ...,
        "HsmsPendingDeletion": ...,
        "HsmsPendingRegistration": ...,
        "Label": ...,
        "LastModifiedTimestamp": ...,
        "PartitionSerialList": ...,
        "State": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeHapgResponseTypeDef(TypedDict):
    HapgArn: str,
    HapgSerial: str,
    HsmsLastActionFailed: List[str],
    HsmsPendingDeletion: List[str],
    HsmsPendingRegistration: List[str],
    Label: str,
    LastModifiedTimestamp: str,
    PartitionSerialList: List[str],
    State: CloudHsmObjectStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CloudHsmObjectStateType
2. See ResponseMetadataTypeDef

DescribeHsmResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DescribeHsmResponseTypeDef

def get_value() -> DescribeHsmResponseTypeDef:
    return {
        "HsmArn": ...,
        "Status": ...,
        "StatusDetails": ...,
        "AvailabilityZone": ...,
        "EniId": ...,
        "EniIp": ...,
        "SubscriptionType": ...,
        "SubscriptionStartDate": ...,
        "SubscriptionEndDate": ...,
        "VpcId": ...,
        "SubnetId": ...,
        "IamRoleArn": ...,
        "SerialNumber": ...,
        "VendorName": ...,
        "HsmType": ...,
        "SoftwareVersion": ...,
        "SshPublicKey": ...,
        "SshKeyLastUpdated": ...,
        "ServerCertUri": ...,
        "ServerCertLastUpdated": ...,
        "Partitions": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeHsmResponseTypeDef(TypedDict):
    HsmArn: str,
    Status: HsmStatusType,  # (1)
    StatusDetails: str,
    AvailabilityZone: str,
    EniId: str,
    EniIp: str,
    SubscriptionType: SubscriptionTypeType,  # (2)
    SubscriptionStartDate: str,
    SubscriptionEndDate: str,
    VpcId: str,
    SubnetId: str,
    IamRoleArn: str,
    SerialNumber: str,
    VendorName: str,
    HsmType: str,
    SoftwareVersion: str,
    SshPublicKey: str,
    SshKeyLastUpdated: str,
    ServerCertUri: str,
    ServerCertLastUpdated: str,
    Partitions: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See HsmStatusType
2. See SubscriptionTypeType
3. See ResponseMetadataTypeDef

DescribeLunaClientResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import DescribeLunaClientResponseTypeDef

def get_value() -> DescribeLunaClientResponseTypeDef:
    return {
        "ClientArn": ...,
        "Certificate": ...,
        "CertificateFingerprint": ...,
        "LastModifiedTimestamp": ...,
        "Label": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeLunaClientResponseTypeDef(TypedDict):
    ClientArn: str,
    Certificate: str,
    CertificateFingerprint: str,
    LastModifiedTimestamp: str,
    Label: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetConfigResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import GetConfigResponseTypeDef

def get_value() -> GetConfigResponseTypeDef:
    return {
        "ConfigType": ...,
        "ConfigFile": ...,
        "ConfigCred": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetConfigResponseTypeDef(TypedDict):
    ConfigType: str,
    ConfigFile: str,
    ConfigCred: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListAvailableZonesResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListAvailableZonesResponseTypeDef

def get_value() -> ListAvailableZonesResponseTypeDef:
    return {
        "AZList": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListAvailableZonesResponseTypeDef(TypedDict):
    AZList: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListHapgsResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListHapgsResponseTypeDef

def get_value() -> ListHapgsResponseTypeDef:
    return {
        "HapgList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListHapgsResponseTypeDef(TypedDict):
    HapgList: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListHsmsResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListHsmsResponseTypeDef

def get_value() -> ListHsmsResponseTypeDef:
    return {
        "HsmList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListHsmsResponseTypeDef(TypedDict):
    HsmList: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListLunaClientsResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListLunaClientsResponseTypeDef

def get_value() -> ListLunaClientsResponseTypeDef:
    return {
        "ClientList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListLunaClientsResponseTypeDef(TypedDict):
    ClientList: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListTagsForResourceResponseTypeDef

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

Definition

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

1. See TagTypeDef
2. See ResponseMetadataTypeDef

ModifyHapgResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ModifyHapgResponseTypeDef

def get_value() -> ModifyHapgResponseTypeDef:
    return {
        "HapgArn": ...,
        "ResponseMetadata": ...,
    }

Definition

class ModifyHapgResponseTypeDef(TypedDict):
    HapgArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ModifyHsmResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ModifyHsmResponseTypeDef

def get_value() -> ModifyHsmResponseTypeDef:
    return {
        "HsmArn": ...,
        "ResponseMetadata": ...,
    }

Definition

class ModifyHsmResponseTypeDef(TypedDict):
    HsmArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ModifyLunaClientResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ModifyLunaClientResponseTypeDef

def get_value() -> ModifyLunaClientResponseTypeDef:
    return {
        "ClientArn": ...,
        "ResponseMetadata": ...,
    }

Definition

class ModifyLunaClientResponseTypeDef(TypedDict):
    ClientArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

RemoveTagsFromResourceResponseTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import RemoveTagsFromResourceResponseTypeDef

def get_value() -> RemoveTagsFromResourceResponseTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }

Definition

class RemoveTagsFromResourceResponseTypeDef(TypedDict):
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListHapgsRequestListHapgsPaginateTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListHapgsRequestListHapgsPaginateTypeDef

def get_value() -> ListHapgsRequestListHapgsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

class ListHapgsRequestListHapgsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListHsmsRequestListHsmsPaginateTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListHsmsRequestListHsmsPaginateTypeDef

def get_value() -> ListHsmsRequestListHsmsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

class ListHsmsRequestListHsmsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListLunaClientsRequestListLunaClientsPaginateTypeDef

Usage Example

from mypy_boto3_cloudhsm.type_defs import ListLunaClientsRequestListLunaClientsPaginateTypeDef

def get_value() -> ListLunaClientsRequestListLunaClientsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

class ListLunaClientsRequestListLunaClientsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef