Type definitions

Index > CloudHSM > Type definitions

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

TagTypeDef

# TagTypeDef definition

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

ResponseMetadataTypeDef

# ResponseMetadataTypeDef definition

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

CreateHapgRequestRequestTypeDef

# CreateHapgRequestRequestTypeDef definition

class CreateHapgRequestRequestTypeDef(TypedDict):
    Label: str,

CreateHsmRequestRequestTypeDef

# CreateHsmRequestRequestTypeDef 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

# CreateLunaClientRequestRequestTypeDef definition

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

DeleteHapgRequestRequestTypeDef

# DeleteHapgRequestRequestTypeDef definition

class DeleteHapgRequestRequestTypeDef(TypedDict):
    HapgArn: str,

DeleteHsmRequestRequestTypeDef

# DeleteHsmRequestRequestTypeDef definition

class DeleteHsmRequestRequestTypeDef(TypedDict):
    HsmArn: str,

DeleteLunaClientRequestRequestTypeDef

# DeleteLunaClientRequestRequestTypeDef definition

class DeleteLunaClientRequestRequestTypeDef(TypedDict):
    ClientArn: str,

DescribeHapgRequestRequestTypeDef

# DescribeHapgRequestRequestTypeDef definition

class DescribeHapgRequestRequestTypeDef(TypedDict):
    HapgArn: str,

DescribeHsmRequestRequestTypeDef

# DescribeHsmRequestRequestTypeDef definition

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

DescribeLunaClientRequestRequestTypeDef

# DescribeLunaClientRequestRequestTypeDef definition

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

GetConfigRequestRequestTypeDef

# GetConfigRequestRequestTypeDef definition

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

1. See ClientVersionType

PaginatorConfigTypeDef

# PaginatorConfigTypeDef definition

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

ListHapgsRequestRequestTypeDef

# ListHapgsRequestRequestTypeDef definition

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

ListHsmsRequestRequestTypeDef

# ListHsmsRequestRequestTypeDef definition

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

ListLunaClientsRequestRequestTypeDef

# ListLunaClientsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ModifyHapgRequestRequestTypeDef

# ModifyHapgRequestRequestTypeDef definition

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

ModifyHsmRequestRequestTypeDef

# ModifyHsmRequestRequestTypeDef definition

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

ModifyLunaClientRequestRequestTypeDef

# ModifyLunaClientRequestRequestTypeDef definition

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

RemoveTagsFromResourceRequestRequestTypeDef

# RemoveTagsFromResourceRequestRequestTypeDef definition

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

AddTagsToResourceRequestRequestTypeDef

# AddTagsToResourceRequestRequestTypeDef definition

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

1. See TagTypeDef

AddTagsToResourceResponseTypeDef

# AddTagsToResourceResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateHapgResponseTypeDef

# CreateHapgResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateHsmResponseTypeDef

# CreateHsmResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateLunaClientResponseTypeDef

# CreateLunaClientResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

DeleteHapgResponseTypeDef

# DeleteHapgResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

DeleteHsmResponseTypeDef

# DeleteHsmResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

DeleteLunaClientResponseTypeDef

# DeleteLunaClientResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

DescribeHapgResponseTypeDef

# DescribeHapgResponseTypeDef 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

# DescribeHsmResponseTypeDef 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

# DescribeLunaClientResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

GetConfigResponseTypeDef

# GetConfigResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListAvailableZonesResponseTypeDef

# ListAvailableZonesResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListHapgsResponseTypeDef

# ListHapgsResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListHsmsResponseTypeDef

# ListHsmsResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListLunaClientsResponseTypeDef

# ListLunaClientsResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef definition

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

1. See TagTypeDef
2. See ResponseMetadataTypeDef

ModifyHapgResponseTypeDef

# ModifyHapgResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ModifyHsmResponseTypeDef

# ModifyHsmResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ModifyLunaClientResponseTypeDef

# ModifyLunaClientResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

RemoveTagsFromResourceResponseTypeDef

# RemoveTagsFromResourceResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListHapgsRequestListHapgsPaginateTypeDef

# ListHapgsRequestListHapgsPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListHsmsRequestListHsmsPaginateTypeDef

# ListHsmsRequestListHsmsPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListLunaClientsRequestListLunaClientsPaginateTypeDef

# ListLunaClientsRequestListLunaClientsPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef