CloudHSM

Table of Contents

Client

class CloudHSM.Client

A low-level client representing Amazon CloudHSM:

import boto3

client = boto3.client('cloudhsm')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters:operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns:True if the operation can be paginated, False otherwise.
create_hapg(**kwargs)

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Request Syntax

response = client.create_hapg(
    Label='string'
)
Parameters:Label (string) --

[REQUIRED]

The label of the new high-availability partition group.

Return type:dict
Returns:Response Syntax
{
    'HapgArn': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the CreateHAPartitionGroup action.

    • HapgArn (string) --

      The ARN of the high-availability partition group.

create_hsm(**kwargs)

Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.

Request Syntax

response = client.create_hsm(
    SubnetId='string',
    SshKey='string',
    EniIp='string',
    IamRoleArn='string',
    ExternalId='string',
    SubscriptionType='PRODUCTION',
    ClientToken='string',
    SyslogIp='string'
)
Parameters:
  • SubnetId (string) --

    [REQUIRED]

    The identifier of the subnet in your VPC in which to place the HSM.

  • SshKey (string) --

    [REQUIRED]

    The SSH public key to install on the HSM.

  • EniIp (string) -- The IP address to assign to the HSM's ENI.
  • IamRoleArn (string) --

    [REQUIRED]

    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

  • ExternalId (string) -- The external ID from IamRoleArn , if present.
  • SubscriptionType (string) --

    [REQUIRED]

    The subscription type.

  • ClientToken (string) -- A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
  • SyslogIp (string) -- The IP address for the syslog monitoring server.
Return type:

dict

Returns:

Response Syntax

{
    'HsmArn': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the CreateHsm action.

    • HsmArn (string) --

      The ARN of the HSM.

create_luna_client(**kwargs)

Creates an HSM client.

Request Syntax

response = client.create_luna_client(
    Label='string',
    Certificate='string'
)
Parameters:
  • Label (string) -- The label for the client.
  • Certificate (string) --

    [REQUIRED]

    The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

Return type:

dict

Returns:

Response Syntax

{
    'ClientArn': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the CreateLunaClient action.

    • ClientArn (string) --

      The ARN of the client.

delete_hapg(**kwargs)

Deletes a high-availability partition group.

Request Syntax

response = client.delete_hapg(
    HapgArn='string'
)
Parameters:HapgArn (string) --

[REQUIRED]

The ARN of the high-availability partition group to delete.

Return type:dict
Returns:Response Syntax
{
    'Status': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the DeleteHapg action.

    • Status (string) --

      The status of the action.

delete_hsm(**kwargs)

Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.

Request Syntax

response = client.delete_hsm(
    HsmArn='string'
)
Parameters:HsmArn (string) --

[REQUIRED]

The ARN of the HSM to delete.

Return type:dict
Returns:Response Syntax
{
    'Status': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the DeleteHsm action.

    • Status (string) --

      The status of the action.

delete_luna_client(**kwargs)

Deletes a client.

Request Syntax

response = client.delete_luna_client(
    ClientArn='string'
)
Parameters:ClientArn (string) --

[REQUIRED]

The ARN of the client to delete.

Return type:dict
Returns:Response Syntax
{
    'Status': 'string'
}

Response Structure

  • (dict) --
    • Status (string) --

      The status of the action.

describe_hapg(**kwargs)

Retrieves information about a high-availability partition group.

Request Syntax

response = client.describe_hapg(
    HapgArn='string'
)
Parameters:HapgArn (string) --

[REQUIRED]

The ARN of the high-availability partition group to describe.

Return type:dict
Returns:Response Syntax
{
    'HapgArn': 'string',
    'HapgSerial': 'string',
    'HsmsLastActionFailed': [
        'string',
    ],
    'HsmsPendingDeletion': [
        'string',
    ],
    'HsmsPendingRegistration': [
        'string',
    ],
    'Label': 'string',
    'LastModifiedTimestamp': 'string',
    'PartitionSerialList': [
        'string',
    ],
    'State': 'READY'|'UPDATING'|'DEGRADED'
}

Response Structure

  • (dict) --

    Contains the output of the DescribeHapg action.

    • HapgArn (string) --

      The ARN of the high-availability partition group.

    • HapgSerial (string) --

      The serial number of the high-availability partition group.

    • HsmsLastActionFailed (list) --

      Contains a list of ARNs that identify the HSMs.

      • (string) --

        An ARN that identifies an HSM.

    • HsmsPendingDeletion (list) --

      Contains a list of ARNs that identify the HSMs.

      • (string) --

        An ARN that identifies an HSM.

    • HsmsPendingRegistration (list) --

      Contains a list of ARNs that identify the HSMs.

      • (string) --

        An ARN that identifies an HSM.

    • Label (string) --

      The label for the high-availability partition group.

    • LastModifiedTimestamp (string) --

      The date and time the high-availability partition group was last modified.

    • PartitionSerialList (list) --

      The list of partition serial numbers that belong to the high-availability partition group.

      • (string) --
    • State (string) --

      The state of the high-availability partition group.

describe_hsm(**kwargs)

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Request Syntax

response = client.describe_hsm(
    HsmArn='string',
    HsmSerialNumber='string'
)
Parameters:
  • HsmArn (string) -- The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
  • HsmSerialNumber (string) -- The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
Return type:

dict

Returns:

Response Syntax

{
    'HsmArn': 'string',
    'Status': 'PENDING'|'RUNNING'|'UPDATING'|'SUSPENDED'|'TERMINATING'|'TERMINATED'|'DEGRADED',
    'StatusDetails': 'string',
    'AvailabilityZone': 'string',
    'EniId': 'string',
    'EniIp': 'string',
    'SubscriptionType': 'PRODUCTION',
    'SubscriptionStartDate': 'string',
    'SubscriptionEndDate': 'string',
    'VpcId': 'string',
    'SubnetId': 'string',
    'IamRoleArn': 'string',
    'SerialNumber': 'string',
    'VendorName': 'string',
    'HsmType': 'string',
    'SoftwareVersion': 'string',
    'SshPublicKey': 'string',
    'SshKeyLastUpdated': 'string',
    'ServerCertUri': 'string',
    'ServerCertLastUpdated': 'string',
    'Partitions': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Contains the output of the DescribeHsm action.

    • HsmArn (string) --

      The ARN of the HSM.

    • Status (string) --

      The status of the HSM.

    • StatusDetails (string) --

      Contains additional information about the status of the HSM.

    • AvailabilityZone (string) --

      The Availability Zone that the HSM is in.

    • EniId (string) --

      The identifier of the elastic network interface (ENI) attached to the HSM.

    • EniIp (string) --

      The IP address assigned to the HSM's ENI.

    • SubscriptionType (string) --

      The subscription type.

    • SubscriptionStartDate (string) --

      The subscription start date.

    • SubscriptionEndDate (string) --

      The subscription end date.

    • VpcId (string) --

      The identifier of the VPC that the HSM is in.

    • SubnetId (string) --

      The identifier of the subnet the HSM is in.

    • IamRoleArn (string) --

      The ARN of the IAM role assigned to the HSM.

    • SerialNumber (string) --

      The serial number of the HSM.

    • VendorName (string) --

      The name of the HSM vendor.

    • HsmType (string) --

      The HSM model type.

    • SoftwareVersion (string) --

      The HSM software version.

    • SshPublicKey (string) --

      The public SSH key.

    • SshKeyLastUpdated (string) --

      The date and time the SSH key was last updated.

    • ServerCertUri (string) --

      The URI of the certificate server.

    • ServerCertLastUpdated (string) --

      The date and time the server certificate was last updated.

    • Partitions (list) --

      The list of partitions on the HSM.

      • (string) --

describe_luna_client(**kwargs)

Retrieves information about an HSM client.

Request Syntax

response = client.describe_luna_client(
    ClientArn='string',
    CertificateFingerprint='string'
)
Parameters:
  • ClientArn (string) -- The ARN of the client.
  • CertificateFingerprint (string) -- The certificate fingerprint.
Return type:

dict

Returns:

Response Syntax

{
    'ClientArn': 'string',
    'Certificate': 'string',
    'CertificateFingerprint': 'string',
    'LastModifiedTimestamp': 'string',
    'Label': 'string'
}

Response Structure

  • (dict) --

    • ClientArn (string) --

      The ARN of the client.

    • Certificate (string) --

      The certificate installed on the HSMs used by this client.

    • CertificateFingerprint (string) --

      The certificate fingerprint.

    • LastModifiedTimestamp (string) --

      The date and time the client was last modified.

    • Label (string) --

      The label of the client.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

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

Parameters:
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns:

The presigned url

get_config(**kwargs)

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Request Syntax

response = client.get_config(
    ClientArn='string',
    ClientVersion='5.1'|'5.3',
    HapgList=[
        'string',
    ]
)
Parameters:
  • ClientArn (string) --

    [REQUIRED]

    The ARN of the client.

  • ClientVersion (string) --

    [REQUIRED]

    The client version.

  • HapgList (list) --

    [REQUIRED]

    A list of ARNs that identify the high-availability partition groups that are associated with the client.

    • (string) --
Return type:

dict

Returns:

Response Syntax

{
    'ConfigType': 'string',
    'ConfigFile': 'string',
    'ConfigCred': 'string'
}

Response Structure

  • (dict) --

    • ConfigType (string) --

      The type of credentials.

    • ConfigFile (string) --

      The chrystoki.conf configuration file.

    • ConfigCred (string) --

      The certificate file containing the server.pem files of the HSMs.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters:operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError:
 Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type:L{botocore.paginate.Paginator}
Returns:A paginator object.
get_waiter(waiter_name)
list_available_zones()

Lists the Availability Zones that have available AWS CloudHSM capacity.

Request Syntax

response = client.list_available_zones()
Return type:dict
Returns:Response Syntax
{
    'AZList': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • AZList (list) --

      The list of Availability Zones that have available AWS CloudHSM capacity.

      • (string) --
list_hapgs(**kwargs)

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Request Syntax

response = client.list_hapgs(
    NextToken='string'
)
Parameters:NextToken (string) -- The NextToken value from a previous call to ListHapgs . Pass null if this is the first call.
Return type:dict
Returns:Response Syntax
{
    'HapgList': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • HapgList (list) --

      The list of high-availability partition groups.

      • (string) --
    • NextToken (string) --

      If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.

list_hsms(**kwargs)

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Request Syntax

response = client.list_hsms(
    NextToken='string'
)
Parameters:NextToken (string) -- The NextToken value from a previous call to ListHsms . Pass null if this is the first call.
Return type:dict
Returns:Response Syntax
{
    'HsmList': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the ListHsms action.

    • HsmList (list) --

      The list of ARNs that identify the HSMs.

      • (string) --

        An ARN that identifies an HSM.

    • NextToken (string) --

      If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

list_luna_clients(**kwargs)

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Request Syntax

response = client.list_luna_clients(
    NextToken='string'
)
Parameters:NextToken (string) -- The NextToken value from a previous call to ListLunaClients . Pass null if this is the first call.
Return type:dict
Returns:Response Syntax
{
    'ClientList': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • ClientList (list) --

      The list of clients.

      • (string) --
    • NextToken (string) --

      If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.

modify_hapg(**kwargs)

Modifies an existing high-availability partition group.

Request Syntax

response = client.modify_hapg(
    HapgArn='string',
    Label='string',
    PartitionSerialList=[
        'string',
    ]
)
Parameters:
  • HapgArn (string) --

    [REQUIRED]

    The ARN of the high-availability partition group to modify.

  • Label (string) -- The new label for the high-availability partition group.
  • PartitionSerialList (list) --

    The list of partition serial numbers to make members of the high-availability partition group.

    • (string) --
Return type:

dict

Returns:

Response Syntax

{
    'HapgArn': 'string'
}

Response Structure

  • (dict) --

    • HapgArn (string) --

      The ARN of the high-availability partition group.

modify_hsm(**kwargs)

Modifies an HSM.

Request Syntax

response = client.modify_hsm(
    HsmArn='string',
    SubnetId='string',
    EniIp='string',
    IamRoleArn='string',
    ExternalId='string',
    SyslogIp='string'
)
Parameters:
  • HsmArn (string) --

    [REQUIRED]

    The ARN of the HSM to modify.

  • SubnetId (string) -- The new identifier of the subnet that the HSM is in.
  • EniIp (string) -- The new IP address for the elastic network interface attached to the HSM.
  • IamRoleArn (string) -- The new IAM role ARN.
  • ExternalId (string) -- The new external ID.
  • SyslogIp (string) -- The new IP address for the syslog monitoring server.
Return type:

dict

Returns:

Response Syntax

{
    'HsmArn': 'string'
}

Response Structure

  • (dict) --

    Contains the output of the ModifyHsm action.

    • HsmArn (string) --

      The ARN of the HSM.

modify_luna_client(**kwargs)

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

Request Syntax

response = client.modify_luna_client(
    ClientArn='string',
    Certificate='string'
)
Parameters:
  • ClientArn (string) --

    [REQUIRED]

    The ARN of the client.

  • Certificate (string) --

    [REQUIRED]

    The new certificate for the client.

Return type:

dict

Returns:

Response Syntax

{
    'ClientArn': 'string'
}

Response Structure

  • (dict) --

    • ClientArn (string) --

      The ARN of the client.