Network.AWS.CloudHSM.DescribeHSM

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

See: AWS API Reference for DescribeHSM.

Creating a Request

describeHSM :: DescribeHSM

Creates a value of DescribeHSM with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dhsmHSMSerialNumber
• dhsmHSMARN

data DescribeHSM

Contains the inputs for the DescribeHsm action.

See: describeHSM smart constructor.

Instances

Eq DescribeHSM

Data DescribeHSM

Read DescribeHSM

Show DescribeHSM

Generic DescribeHSM

ToJSON DescribeHSM

AWSRequest DescribeHSM

ToPath DescribeHSM

ToHeaders DescribeHSM

ToQuery DescribeHSM

Typeable * DescribeHSM

type Rep DescribeHSM

type Rs DescribeHSM = DescribeHSMResponse

Request Lenses

dhsmHSMSerialNumber :: Lens' DescribeHSM (Maybe Text)

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

dhsmHSMARN :: Lens' DescribeHSM (Maybe Text)

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

Destructuring the Response

describeHSMResponse

Arguments

:: Int

desrsResponseStatus

-> DescribeHSMResponse

Creates a value of DescribeHSMResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• desrsStatus
• desrsIAMRoleARN
• desrsEniId
• desrsVPCId
• desrsSSHKeyLastUpdated
• desrsSubscriptionEndDate
• desrsServerCertURI
• desrsSubscriptionType
• desrsSSHPublicKey
• desrsSubnetId
• desrsStatusDetails
• desrsPartitions
• desrsSubscriptionStartDate
• desrsAvailabilityZone
• desrsServerCertLastUpdated
• desrsSoftwareVersion
• desrsVendorName
• desrsSerialNumber
• desrsHSMARN
• desrsEniIP
• desrsHSMType
• desrsResponseStatus

data DescribeHSMResponse

Contains the output of the DescribeHsm action.

See: describeHSMResponse smart constructor.

Instances

Eq DescribeHSMResponse

Data DescribeHSMResponse

Read DescribeHSMResponse

Show DescribeHSMResponse

Generic DescribeHSMResponse

Typeable * DescribeHSMResponse

type Rep DescribeHSMResponse

Response Lenses

desrsStatus :: Lens' DescribeHSMResponse (Maybe HSMStatus)

The status of the HSM.

desrsIAMRoleARN :: Lens' DescribeHSMResponse (Maybe Text)

The ARN of the IAM role assigned to the HSM.

desrsEniId :: Lens' DescribeHSMResponse (Maybe Text)

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

desrsVPCId :: Lens' DescribeHSMResponse (Maybe Text)

The identifier of the VPC that the HSM is in.

desrsSSHKeyLastUpdated :: Lens' DescribeHSMResponse (Maybe Text)

The date and time the SSH key was last updated.

desrsSubscriptionEndDate :: Lens' DescribeHSMResponse (Maybe Text)

The subscription end date.

desrsServerCertURI :: Lens' DescribeHSMResponse (Maybe Text)

The URI of the certificate server.

desrsSubscriptionType :: Lens' DescribeHSMResponse (Maybe SubscriptionType)

The subscription type.

desrsSSHPublicKey :: Lens' DescribeHSMResponse (Maybe Text)

The public SSH key.

desrsSubnetId :: Lens' DescribeHSMResponse (Maybe Text)

The identifier of the subnet the HSM is in.

desrsStatusDetails :: Lens' DescribeHSMResponse (Maybe Text)

Contains additional information about the status of the HSM.

desrsPartitions :: Lens' DescribeHSMResponse [Text]

The list of partitions on the HSM.

desrsSubscriptionStartDate :: Lens' DescribeHSMResponse (Maybe Text)

The subscription start date.

desrsAvailabilityZone :: Lens' DescribeHSMResponse (Maybe Text)

The Availability Zone that the HSM is in.

desrsServerCertLastUpdated :: Lens' DescribeHSMResponse (Maybe Text)

The date and time the server certificate was last updated.

desrsSoftwareVersion :: Lens' DescribeHSMResponse (Maybe Text)

The HSM software version.

desrsVendorName :: Lens' DescribeHSMResponse (Maybe Text)

The name of the HSM vendor.

desrsSerialNumber :: Lens' DescribeHSMResponse (Maybe Text)

The serial number of the HSM.

desrsHSMARN :: Lens' DescribeHSMResponse (Maybe Text)

The ARN of the HSM.

desrsEniIP :: Lens' DescribeHSMResponse (Maybe Text)

The IP address assigned to the HSM's ENI.

desrsHSMType :: Lens' DescribeHSMResponse (Maybe Text)

The HSM model type.

desrsResponseStatus :: Lens' DescribeHSMResponse Int

The response status code.