Describe Hsm

cloudhsm_describe_hsm

R Documentation

This is documentation for AWS CloudHSM Classic¶

Description¶

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.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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

Usage¶

cloudhsm_describe_hsm(HsmArn, HsmSerialNumber)

Arguments¶

HsmArn: The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
HsmSerialNumber: The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

Value¶

A list with the following syntax:

list(
  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 = list(
    "string"
  )
)

Request syntax¶

svc$describe_hsm(
  HsmArn = "string",
  HsmSerialNumber = "string"
)