Skip to content

CloudHSMClient

Index > CloudHSM > CloudHSMClient

Auto-generated documentation for CloudHSM type annotations stubs module types-aiobotocore-cloudhsm.

CloudHSMClient

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

Usage example
from aioboto3.session import Session
from types_aiobotocore_cloudhsm.client import CloudHSMClient

session = Session()
async with session.client("cloudhsm") as client:
    client: CloudHSMClient

Exceptions

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

Usage example
async with session.client("cloudhsm") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.CloudHsmInternalException,
        client.CloudHsmServiceException,
        client.InvalidRequestException,
    ) as e:
        print(e)
Type checking example
from types_aiobotocore_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 session.client("cloudhsm").add_tags_to_resource method. boto3 documentation

Method definition
await def add_tags_to_resource(
    self,
    *,
    ResourceArn: str,
    TagList: Sequence[TagTypeDef],  # (1)
) -> AddTagsToResourceResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See AddTagsToResourceResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").can_paginate method. boto3 documentation

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

close

Closes underlying endpoint connections.

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

Method definition
await def close(
    self,
) -> None:
    ...

create_hapg

This is documentation for AWS CloudHSM Classic.

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

Method definition
await def create_hapg(
    self,
    *,
    Label: str,
) -> CreateHapgResponseTypeDef:  # (1)
    ...
  1. See CreateHapgResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").create_hsm method. boto3 documentation

Method definition
await 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
Usage example with kwargs
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 session.client("cloudhsm").create_luna_client method. boto3 documentation

Method definition
await def create_luna_client(
    self,
    *,
    Certificate: str,
    Label: str = ...,
) -> CreateLunaClientResponseTypeDef:  # (1)
    ...
  1. See CreateLunaClientResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").delete_hapg method. boto3 documentation

Method definition
await def delete_hapg(
    self,
    *,
    HapgArn: str,
) -> DeleteHapgResponseTypeDef:  # (1)
    ...
  1. See DeleteHapgResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").delete_hsm method. boto3 documentation

Method definition
await def delete_hsm(
    self,
    *,
    HsmArn: str,
) -> DeleteHsmResponseTypeDef:  # (1)
    ...
  1. See DeleteHsmResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").delete_luna_client method. boto3 documentation

Method definition
await def delete_luna_client(
    self,
    *,
    ClientArn: str,
) -> DeleteLunaClientResponseTypeDef:  # (1)
    ...
  1. See DeleteLunaClientResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").describe_hapg method. boto3 documentation

Method definition
await def describe_hapg(
    self,
    *,
    HapgArn: str,
) -> DescribeHapgResponseTypeDef:  # (1)
    ...
  1. See DescribeHapgResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").describe_hsm method. boto3 documentation

Method definition
await def describe_hsm(
    self,
    *,
    HsmArn: str = ...,
    HsmSerialNumber: str = ...,
) -> DescribeHsmResponseTypeDef:  # (1)
    ...
  1. See DescribeHsmResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").describe_luna_client method. boto3 documentation

Method definition
await def describe_luna_client(
    self,
    *,
    ClientArn: str = ...,
    CertificateFingerprint: str = ...,
) -> DescribeLunaClientResponseTypeDef:  # (1)
    ...
  1. See DescribeLunaClientResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").generate_presigned_url method. boto3 documentation

Method definition
await 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 session.client("cloudhsm").get_config method. boto3 documentation

Method definition
await def get_config(
    self,
    *,
    ClientArn: str,
    ClientVersion: ClientVersionType,  # (1)
    HapgList: Sequence[str],
) -> GetConfigResponseTypeDef:  # (2)
    ...
  1. See ClientVersionType
  2. See GetConfigResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").list_available_zones method. boto3 documentation

Method definition
await 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 session.client("cloudhsm").list_hapgs method. boto3 documentation

Method definition
await def list_hapgs(
    self,
    *,
    NextToken: str = ...,
) -> ListHapgsResponseTypeDef:  # (1)
    ...
  1. See ListHapgsResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").list_hsms method. boto3 documentation

Method definition
await def list_hsms(
    self,
    *,
    NextToken: str = ...,
) -> ListHsmsResponseTypeDef:  # (1)
    ...
  1. See ListHsmsResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").list_luna_clients method. boto3 documentation

Method definition
await def list_luna_clients(
    self,
    *,
    NextToken: str = ...,
) -> ListLunaClientsResponseTypeDef:  # (1)
    ...
  1. See ListLunaClientsResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").list_tags_for_resource method. boto3 documentation

Method definition
await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").modify_hapg method. boto3 documentation

Method definition
await def modify_hapg(
    self,
    *,
    HapgArn: str,
    Label: str = ...,
    PartitionSerialList: Sequence[str] = ...,
) -> ModifyHapgResponseTypeDef:  # (1)
    ...
  1. See ModifyHapgResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").modify_hsm method. boto3 documentation

Method definition
await def modify_hsm(
    self,
    *,
    HsmArn: str,
    SubnetId: str = ...,
    EniIp: str = ...,
    IamRoleArn: str = ...,
    ExternalId: str = ...,
    SyslogIp: str = ...,
) -> ModifyHsmResponseTypeDef:  # (1)
    ...
  1. See ModifyHsmResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").modify_luna_client method. boto3 documentation

Method definition
await def modify_luna_client(
    self,
    *,
    ClientArn: str,
    Certificate: str,
) -> ModifyLunaClientResponseTypeDef:  # (1)
    ...
  1. See ModifyLunaClientResponseTypeDef
Usage example with kwargs
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 session.client("cloudhsm").remove_tags_from_resource method. boto3 documentation

Method definition
await def remove_tags_from_resource(
    self,
    *,
    ResourceArn: str,
    TagKeyList: Sequence[str],
) -> RemoveTagsFromResourceResponseTypeDef:  # (1)
    ...
  1. See RemoveTagsFromResourceResponseTypeDef
Usage example with kwargs
kwargs: RemoveTagsFromResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeyList": ...,
}

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

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> CloudHSMClient:
    ...

__aexit__

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

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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