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.