Skip to content

CloudHSMClient#

Index > CloudHSM > CloudHSMClient

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

CloudHSMClient#

Type annotations and code completion for boto3.client("cloudhsm"). boto3 documentation

# CloudHSMClient usage example

from boto3.session import Session
from mypy_boto3_cloudhsm.client import CloudHSMClient

def get_cloudhsm_client() -> CloudHSMClient:
    return Session().client("cloudhsm")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cloudhsm").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("cloudhsm")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.CloudHsmInternalException,
    client.exceptions.CloudHsmServiceException,
    client.exceptions.InvalidRequestException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_cloudhsm.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

add_tags_to_resource#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").add_tags_to_resource method. boto3 documentation

# add_tags_to_resource method definition

def add_tags_to_resource(
    self,
    *,
    ResourceArn: str,
    TagList: Sequence[TagTypeDef],  # (1)
) -> AddTagsToResourceResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See AddTagsToResourceResponseTypeDef 
# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagList": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cloudhsm").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("cloudhsm").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_hapg#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").create_hapg method. boto3 documentation

# create_hapg method definition

def create_hapg(
    self,
    *,
    Label: str,
) -> CreateHapgResponseTypeDef:  # (1)
    ...
  1. See CreateHapgResponseTypeDef 
# create_hapg method usage example with argument unpacking

kwargs: CreateHapgRequestRequestTypeDef = {  # (1)
    "Label": ...,
}

parent.create_hapg(**kwargs)
  1. See CreateHapgRequestRequestTypeDef

create_hsm#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").create_hsm method. boto3 documentation

# create_hsm method definition

def create_hsm(
    self,
    *,
    SubnetId: str,
    SshKey: str,
    IamRoleArn: str,
    SubscriptionType: SubscriptionTypeType,  # (1)
    EniIp: str = ...,
    ExternalId: str = ...,
    ClientToken: str = ...,
    SyslogIp: str = ...,
) -> CreateHsmResponseTypeDef:  # (2)
    ...
  1. See SubscriptionTypeType
  2. See CreateHsmResponseTypeDef 
# create_hsm method usage example with argument unpacking

kwargs: CreateHsmRequestRequestTypeDef = {  # (1)
    "SubnetId": ...,
    "SshKey": ...,
    "IamRoleArn": ...,
    "SubscriptionType": ...,
}

parent.create_hsm(**kwargs)
  1. See CreateHsmRequestRequestTypeDef

create_luna_client#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").create_luna_client method. boto3 documentation

# create_luna_client method definition

def create_luna_client(
    self,
    *,
    Certificate: str,
    Label: str = ...,
) -> CreateLunaClientResponseTypeDef:  # (1)
    ...
  1. See CreateLunaClientResponseTypeDef 
# create_luna_client method usage example with argument unpacking

kwargs: CreateLunaClientRequestRequestTypeDef = {  # (1)
    "Certificate": ...,
}

parent.create_luna_client(**kwargs)
  1. See CreateLunaClientRequestRequestTypeDef

delete_hapg#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").delete_hapg method. boto3 documentation

# delete_hapg method definition

def delete_hapg(
    self,
    *,
    HapgArn: str,
) -> DeleteHapgResponseTypeDef:  # (1)
    ...
  1. See DeleteHapgResponseTypeDef 
# delete_hapg method usage example with argument unpacking

kwargs: DeleteHapgRequestRequestTypeDef = {  # (1)
    "HapgArn": ...,
}

parent.delete_hapg(**kwargs)
  1. See DeleteHapgRequestRequestTypeDef

delete_hsm#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").delete_hsm method. boto3 documentation

# delete_hsm method definition

def delete_hsm(
    self,
    *,
    HsmArn: str,
) -> DeleteHsmResponseTypeDef:  # (1)
    ...
  1. See DeleteHsmResponseTypeDef 
# delete_hsm method usage example with argument unpacking

kwargs: DeleteHsmRequestRequestTypeDef = {  # (1)
    "HsmArn": ...,
}

parent.delete_hsm(**kwargs)
  1. See DeleteHsmRequestRequestTypeDef

delete_luna_client#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").delete_luna_client method. boto3 documentation

# delete_luna_client method definition

def delete_luna_client(
    self,
    *,
    ClientArn: str,
) -> DeleteLunaClientResponseTypeDef:  # (1)
    ...
  1. See DeleteLunaClientResponseTypeDef 
# delete_luna_client method usage example with argument unpacking

kwargs: DeleteLunaClientRequestRequestTypeDef = {  # (1)
    "ClientArn": ...,
}

parent.delete_luna_client(**kwargs)
  1. See DeleteLunaClientRequestRequestTypeDef

describe_hapg#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").describe_hapg method. boto3 documentation

# describe_hapg method definition

def describe_hapg(
    self,
    *,
    HapgArn: str,
) -> DescribeHapgResponseTypeDef:  # (1)
    ...
  1. See DescribeHapgResponseTypeDef 
# describe_hapg method usage example with argument unpacking

kwargs: DescribeHapgRequestRequestTypeDef = {  # (1)
    "HapgArn": ...,
}

parent.describe_hapg(**kwargs)
  1. See DescribeHapgRequestRequestTypeDef

describe_hsm#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").describe_hsm method. boto3 documentation

# describe_hsm method definition

def describe_hsm(
    self,
    *,
    HsmArn: str = ...,
    HsmSerialNumber: str = ...,
) -> DescribeHsmResponseTypeDef:  # (1)
    ...
  1. See DescribeHsmResponseTypeDef 
# describe_hsm method usage example with argument unpacking

kwargs: DescribeHsmRequestRequestTypeDef = {  # (1)
    "HsmArn": ...,
}

parent.describe_hsm(**kwargs)
  1. See DescribeHsmRequestRequestTypeDef

describe_luna_client#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").describe_luna_client method. boto3 documentation

# describe_luna_client method definition

def describe_luna_client(
    self,
    *,
    ClientArn: str = ...,
    CertificateFingerprint: str = ...,
) -> DescribeLunaClientResponseTypeDef:  # (1)
    ...
  1. See DescribeLunaClientResponseTypeDef 
# describe_luna_client method usage example with argument unpacking

kwargs: DescribeLunaClientRequestRequestTypeDef = {  # (1)
    "ClientArn": ...,
}

parent.describe_luna_client(**kwargs)
  1. See DescribeLunaClientRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cloudhsm").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_config#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").get_config method. boto3 documentation

# get_config method definition

def get_config(
    self,
    *,
    ClientArn: str,
    ClientVersion: ClientVersionType,  # (1)
    HapgList: Sequence[str],
) -> GetConfigResponseTypeDef:  # (2)
    ...
  1. See ClientVersionType
  2. See GetConfigResponseTypeDef 
# get_config method usage example with argument unpacking

kwargs: GetConfigRequestRequestTypeDef = {  # (1)
    "ClientArn": ...,
    "ClientVersion": ...,
    "HapgList": ...,
}

parent.get_config(**kwargs)
  1. See GetConfigRequestRequestTypeDef

list_available_zones#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").list_available_zones method. boto3 documentation

# list_available_zones method definition

def list_available_zones(
    self,
) -> ListAvailableZonesResponseTypeDef:  # (1)
    ...
  1. See ListAvailableZonesResponseTypeDef

list_hapgs#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").list_hapgs method. boto3 documentation

# list_hapgs method definition

def list_hapgs(
    self,
    *,
    NextToken: str = ...,
) -> ListHapgsResponseTypeDef:  # (1)
    ...
  1. See ListHapgsResponseTypeDef 
# list_hapgs method usage example with argument unpacking

kwargs: ListHapgsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_hapgs(**kwargs)
  1. See ListHapgsRequestRequestTypeDef

list_hsms#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").list_hsms method. boto3 documentation

# list_hsms method definition

def list_hsms(
    self,
    *,
    NextToken: str = ...,
) -> ListHsmsResponseTypeDef:  # (1)
    ...
  1. See ListHsmsResponseTypeDef 
# list_hsms method usage example with argument unpacking

kwargs: ListHsmsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_hsms(**kwargs)
  1. See ListHsmsRequestRequestTypeDef

list_luna_clients#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").list_luna_clients method. boto3 documentation

# list_luna_clients method definition

def list_luna_clients(
    self,
    *,
    NextToken: str = ...,
) -> ListLunaClientsResponseTypeDef:  # (1)
    ...
  1. See ListLunaClientsResponseTypeDef 
# list_luna_clients method usage example with argument unpacking

kwargs: ListLunaClientsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_luna_clients(**kwargs)
  1. See ListLunaClientsRequestRequestTypeDef

list_tags_for_resource#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

modify_hapg#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").modify_hapg method. boto3 documentation

# modify_hapg method definition

def modify_hapg(
    self,
    *,
    HapgArn: str,
    Label: str = ...,
    PartitionSerialList: Sequence[str] = ...,
) -> ModifyHapgResponseTypeDef:  # (1)
    ...
  1. See ModifyHapgResponseTypeDef 
# modify_hapg method usage example with argument unpacking

kwargs: ModifyHapgRequestRequestTypeDef = {  # (1)
    "HapgArn": ...,
}

parent.modify_hapg(**kwargs)
  1. See ModifyHapgRequestRequestTypeDef

modify_hsm#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").modify_hsm method. boto3 documentation

# modify_hsm method definition

def modify_hsm(
    self,
    *,
    HsmArn: str,
    SubnetId: str = ...,
    EniIp: str = ...,
    IamRoleArn: str = ...,
    ExternalId: str = ...,
    SyslogIp: str = ...,
) -> ModifyHsmResponseTypeDef:  # (1)
    ...
  1. See ModifyHsmResponseTypeDef 
# modify_hsm method usage example with argument unpacking

kwargs: ModifyHsmRequestRequestTypeDef = {  # (1)
    "HsmArn": ...,
}

parent.modify_hsm(**kwargs)
  1. See ModifyHsmRequestRequestTypeDef

modify_luna_client#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").modify_luna_client method. boto3 documentation

# modify_luna_client method definition

def modify_luna_client(
    self,
    *,
    ClientArn: str,
    Certificate: str,
) -> ModifyLunaClientResponseTypeDef:  # (1)
    ...
  1. See ModifyLunaClientResponseTypeDef 
# modify_luna_client method usage example with argument unpacking

kwargs: ModifyLunaClientRequestRequestTypeDef = {  # (1)
    "ClientArn": ...,
    "Certificate": ...,
}

parent.modify_luna_client(**kwargs)
  1. See ModifyLunaClientRequestRequestTypeDef

remove_tags_from_resource#

This is documentation for AWS CloudHSM Classic.

Type annotations and code completion for boto3.client("cloudhsm").remove_tags_from_resource method. boto3 documentation

# remove_tags_from_resource method definition

def remove_tags_from_resource(
    self,
    *,
    ResourceArn: str,
    TagKeyList: Sequence[str],
) -> RemoveTagsFromResourceResponseTypeDef:  # (1)
    ...
  1. See RemoveTagsFromResourceResponseTypeDef 
# remove_tags_from_resource method usage example with argument unpacking

kwargs: RemoveTagsFromResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeyList": ...,
}

parent.remove_tags_from_resource(**kwargs)
  1. See RemoveTagsFromResourceRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("cloudhsm").get_paginator method with overloads.