CloudHSM ¶

Table of Contents

CloudHSM
- Client
- Paginators

Client ¶

class CloudHSM.Client¶

A low-level client representing Amazon CloudHSM

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

import boto3

client = boto3.client('cloudhsm')

These are the available methods:

add_tags_to_resource(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

Each tag consists of a key and a value. Tag keys must be unique to each resource.

See also: AWS API Documentation

Request Syntax

response = client.add_tags_to_resource(
    ResourceArn='string',
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
TagList (list) --
[REQUIRED]

One or more tags.
- (dict) --
  A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.
  - Key (string) -- [REQUIRED]
    The key of the tag.
  - Value (string) -- [REQUIRED]
    The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'Status': 'string'
}

Response Structure

(dict) --
- Status (string) --
  
  The status of the operation.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

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.

close()¶: Closes underlying endpoint connections.

create_hapg(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

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

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

create_hsm(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center , create a new case, and select Account and Billing Support .

Warning

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING .

See also: AWS API Documentation

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.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
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]

Specifies the type of subscription for the HSM.
- PRODUCTION - The HSM is being used in a production environment.
- TRIAL - The HSM is being used in a product trial.
ClientToken (string) -- A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
SyslogIp (string) -- The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Return type

dict

Returns

Response Syntax

{
    'HsmArn': 'string'
}

Response Structure

(dict) --

Contains the output of the CreateHsm operation.
- HsmArn (string) --
  
  The ARN of the HSM.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

create_luna_client(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Creates an HSM client.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

delete_hapg(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Deletes a high-availability partition group.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

delete_hsm(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

See also: AWS API Documentation

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 operation.
- Status (string) --
  The status of the operation.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

delete_luna_client(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Deletes a client.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

describe_hapg(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Retrieves information about a high-availability partition group.

See also: AWS API Documentation

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) --
  - (string) --
    An ARN that identifies an HSM.
- HsmsPendingDeletion (list) --
  - (string) --
    An ARN that identifies an HSM.
- HsmsPendingRegistration (list) --
  - (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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

describe_hsm(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

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

See also: AWS API Documentation

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 operation.
- 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) --
  
  Specifies the type of subscription for the HSM.
  - PRODUCTION - The HSM is being used in a production environment.
  - TRIAL - The HSM is being used in a product trial.
- 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 that 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 that the SSH key was last updated.
- ServerCertUri (string) --
  
  The URI of the certificate server.
- ServerCertLastUpdated (string) --
  
  The date and time that the server certificate was last updated.
- Partitions (list) --
  
  The list of partitions on the HSM.
  - (string) --

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

describe_luna_client(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Retrieves information about an HSM client.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

get_config(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

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

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

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)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_available_zones()¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Lists the Availability Zones that have available AWS CloudHSM capacity.

See also: AWS API Documentation

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) --

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

list_hapgs(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

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.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

list_hsms(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

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.

See also: AWS API Documentation

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 operation.
- 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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

list_luna_clients(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

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.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

list_tags_for_resource(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Returns a list of all tags for the specified AWS CloudHSM resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

Return type

dict

Returns

Response Syntax

{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- TagList (list) --
  One or more tags.
  - (dict) --
    A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.
    - Key (string) --
      The key of the tag.
    - Value (string) --
      The value of the tag.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

modify_hapg(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Modifies an existing high-availability partition group.

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

modify_hsm(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Modifies an HSM.

Warning

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

See also: AWS API Documentation

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. The new subnet must be in the same Availability Zone as the current subnet.
EniIp (string) --
The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
IamRoleArn (string) -- The new IAM role ARN.
ExternalId (string) -- The new external ID.
SyslogIp (string) -- The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Return type

dict

Returns

Response Syntax

{
    'HsmArn': 'string'
}

Response Structure

(dict) --

Contains the output of the ModifyHsm operation.
- HsmArn (string) --
  
  The ARN of the HSM.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

modify_luna_client(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Modifies the certificate used by the client.

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

See also: AWS API Documentation

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.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException

remove_tags_from_resource(**kwargs)¶

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource .

See also: AWS API Documentation

Request Syntax

response = client.remove_tags_from_resource(
    ResourceArn='string',
    TagKeyList=[
        'string',
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
TagKeyList (list) --
[REQUIRED]

The tag key or keys to remove.

Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource .
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Status': 'string'
}

Response Structure

(dict) --
- Status (string) --
  
  The status of the operation.

Exceptions

CloudHSM.Client.exceptions.CloudHsmServiceException
CloudHSM.Client.exceptions.CloudHsmInternalException
CloudHSM.Client.exceptions.InvalidRequestException

Paginators ¶

The available paginators are:

CloudHSM.Paginator.ListHapgs
CloudHSM.Paginator.ListHsms
CloudHSM.Paginator.ListLunaClients

class CloudHSM.Paginator.ListHapgs¶

paginator = client.get_paginator('list_hapgs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudHSM.Client.list_hapgs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'HapgList': [
        'string',
    ],

}

Response Structure

(dict) --
- HapgList (list) --
  The list of high-availability partition groups.
  - (string) --

class CloudHSM.Paginator.ListHsms¶

paginator = client.get_paginator('list_hsms')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudHSM.Client.list_hsms().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'HsmList': [
        'string',
    ],

}

Response Structure

(dict) --
Contains the output of the ListHsms operation.
- HsmList (list) --
  The list of ARNs that identify the HSMs.
  - (string) --
    An ARN that identifies an HSM.

class CloudHSM.Paginator.ListLunaClients¶

paginator = client.get_paginator('list_luna_clients')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudHSM.Client.list_luna_clients().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ClientList': [
        'string',
    ],

}

Response Structure

(dict) --
- ClientList (list) --
  The list of clients.
  - (string) --

Table Of Contents

CloudHSM¶

Client¶

Paginators¶

CloudHSM ¶

Client ¶

Paginators ¶