2015/01/08 - Amazon CloudHSM - 17 new api methods
Modifies an existing high-availability partition group.
Request Syntax
client.modify_hapg(
HapgArn='string',
Label='string',
PartitionSerialList=[
'string',
]
)
string
[REQUIRED]
The ARN of the high-availability partition group to modify.
string
The new label for the high-availability partition group.
list
The list of partition serial numbers to make members of the high-availability partition group.
(string) --
dict
Response Syntax
{
'HapgArn': 'string'
}
Response Structure
(dict) --
HapgArn (string) --
The ARN of the high-availability partition group.
Creates an HSM client.
Request Syntax
client.create_luna_client(
Label='string',
Certificate='string'
)
string
The label for the client.
string
[REQUIRED]
The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
dict
Response Syntax
{
'ClientArn': 'string'
}
Response Structure
(dict) --
Contains the output of the CreateLunaClient action.
ClientArn (string) --
The ARN of the client.
Retrieves information about a high-availability partition group.
Request Syntax
client.describe_hapg(
HapgArn='string'
)
string
[REQUIRED]
The ARN of the high-availability partition group to describe.
dict
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.
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
client.list_luna_clients(
NextToken='string'
)
string
The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
dict
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.
Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.
Request Syntax
client.delete_hsm(
HsmArn='string'
)
string
[REQUIRED]
The ARN of the HSM to delete.
dict
Response Syntax
{
'Status': 'string'
}
Response Structure
(dict) --
Contains the output of the DeleteHsm action.
Status (string) --
The status of the action.
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
Request Syntax
client.create_hapg(
Label='string'
)
string
[REQUIRED]
The label of the new high-availability partition group.
dict
Response Syntax
{
'HapgArn': 'string'
}
Response Structure
(dict) --
Contains the output of the CreateHAPartitionGroup action.
HapgArn (string) --
The ARN of the high-availability partition group.
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
Request Syntax
client.get_config(
ClientArn='string',
ClientVersion='5.1'|'5.3',
HapgList=[
'string',
]
)
string
[REQUIRED]
The ARN of the client.
string
[REQUIRED]
The client version.
list
[REQUIRED]
A list of ARNs that identify the high-availability partition groups that are associated with the client.
(string) --
dict
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.
Lists the Availability Zones that have available AWS CloudHSM capacity.
Request Syntax
client.list_available_zones()
dict
Response Syntax
{
'AZList': [
'string',
]
}
Response Structure
(dict) --
AZList (list) --
The list of Availability Zones that have available AWS CloudHSM capacity.
(string) --
Deletes a client.
Request Syntax
client.delete_luna_client(
ClientArn='string'
)
string
[REQUIRED]
The ARN of the client to delete.
dict
Response Syntax
{
'Status': 'string'
}
Response Structure
(dict) --
Status (string) --
The status of the action.
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
client.modify_luna_client(
ClientArn='string',
Certificate='string'
)
string
[REQUIRED]
The ARN of the client.
string
[REQUIRED]
The new certificate for the client.
dict
Response Syntax
{
'ClientArn': 'string'
}
Response Structure
(dict) --
ClientArn (string) --
The ARN of the client.
Deletes a high-availability partition group.
Request Syntax
client.delete_hapg(
HapgArn='string'
)
string
[REQUIRED]
The ARN of the high-availability partition group to delete.
dict
Response Syntax
{
'Status': 'string'
}
Response Structure
(dict) --
Contains the output of the DeleteHapg action.
Status (string) --
The status of the action.
Retrieves information about an HSM client.
Request Syntax
client.describe_luna_client(
ClientArn='string',
CertificateFingerprint='string'
)
string
The ARN of the client.
string
The certificate fingerprint.
dict
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.
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
Request Syntax
client.describe_hsm(
HsmArn='string',
HsmSerialNumber='string'
)
string
The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
string
The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
dict
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) --
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
client.create_hsm(
SubnetId='string',
SshKey='string',
EniIp='string',
IamRoleArn='string',
ExternalId='string',
SubscriptionType='PRODUCTION',
ClientToken='string',
SyslogIp='string'
)
string
[REQUIRED]
The identifier of the subnet in your VPC in which to place the HSM.
string
[REQUIRED]
The SSH public key to install on the HSM.
string
The IP address to assign to the HSM's ENI.
string
[REQUIRED]
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
string
The external ID from IamRoleArn , if present.
string
[REQUIRED]
The subscription type.
string
A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
string
The IP address for the syslog monitoring server.
dict
Response Syntax
{
'HsmArn': 'string'
}
Response Structure
(dict) --
Contains the output of the CreateHsm action.
HsmArn (string) --
The ARN of the HSM.
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
client.list_hapgs(
NextToken='string'
)
string
The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.
dict
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.
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
client.list_hsms(
NextToken='string'
)
string
The NextToken value from a previous call to ListHsms. Pass null if this is the first call.
dict
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.
Modifies an HSM.
Request Syntax
client.modify_hsm(
HsmArn='string',
SubnetId='string',
EniIp='string',
IamRoleArn='string',
ExternalId='string',
SyslogIp='string'
)
string
[REQUIRED]
The ARN of the HSM to modify.
string
The new identifier of the subnet that the HSM is in.
string
The new IP address for the elastic network interface attached to the HSM.
string
The new IAM role ARN.
string
The new external ID.
string
The new IP address for the syslog monitoring server.
dict
Response Syntax
{
'HsmArn': 'string'
}
Response Structure
(dict) --
Contains the output of the ModifyHsm action.
HsmArn (string) --
The ARN of the HSM.