Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudHSM.DescribeHsm

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

data DescribeHsm = DescribeHsm' {
- hsmArn :: Maybe Text
- hsmSerialNumber :: Maybe Text
}
newDescribeHsm :: DescribeHsm
describeHsm_hsmArn :: Lens' DescribeHsm (Maybe Text)
describeHsm_hsmSerialNumber :: Lens' DescribeHsm (Maybe Text)
data DescribeHsmResponse = DescribeHsmResponse' {
- availabilityZone :: Maybe Text
- eniId :: Maybe Text
- eniIp :: Maybe Text
- hsmArn :: Maybe Text
- hsmType :: Maybe Text
- iamRoleArn :: Maybe Text
- partitions :: Maybe [Text]
- serialNumber :: Maybe Text
- serverCertLastUpdated :: Maybe Text
- serverCertUri :: Maybe Text
- softwareVersion :: Maybe Text
- sshKeyLastUpdated :: Maybe Text
- sshPublicKey :: Maybe Text
- status :: Maybe HsmStatus
- statusDetails :: Maybe Text
- subnetId :: Maybe Text
- subscriptionEndDate :: Maybe Text
- subscriptionStartDate :: Maybe Text
- subscriptionType :: Maybe SubscriptionType
- vendorName :: Maybe Text
- vpcId :: Maybe Text
- httpStatus :: Int
}
newDescribeHsmResponse :: Int -> DescribeHsmResponse
describeHsmResponse_availabilityZone :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_eniId :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_eniIp :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_hsmArn :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_hsmType :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_iamRoleArn :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_partitions :: Lens' DescribeHsmResponse (Maybe [Text])
describeHsmResponse_serialNumber :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_serverCertLastUpdated :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_serverCertUri :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_softwareVersion :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_sshKeyLastUpdated :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_sshPublicKey :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_status :: Lens' DescribeHsmResponse (Maybe HsmStatus)
describeHsmResponse_statusDetails :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_subnetId :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_subscriptionEndDate :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_subscriptionStartDate :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_subscriptionType :: Lens' DescribeHsmResponse (Maybe SubscriptionType)
describeHsmResponse_vendorName :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_vpcId :: Lens' DescribeHsmResponse (Maybe Text)
describeHsmResponse_httpStatus :: Lens' DescribeHsmResponse Int

Creating a Request

data DescribeHsm Source #

Contains the inputs for the DescribeHsm operation.

See: newDescribeHsm smart constructor.

Constructors

DescribeHsm'
Fields hsmArn :: Maybe Text The ARN of the HSM. Either the `HsmArn` or the `SerialNumber` parameter must be specified. hsmSerialNumber :: Maybe Text The serial number of the HSM. Either the `HsmArn` or the `HsmSerialNumber` parameter must be specified.

Instances

Instances details

ToJSON DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods toJSON :: DescribeHsm -> Value # toEncoding :: DescribeHsm -> Encoding # toJSONList :: [DescribeHsm] -> Value # toEncodingList :: [DescribeHsm] -> Encoding #
ToHeaders DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods toHeaders :: DescribeHsm -> [Header] #
ToPath DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods toPath :: DescribeHsm -> ByteString #
ToQuery DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods toQuery :: DescribeHsm -> QueryString #
AWSRequest DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Associated Types type AWSResponse DescribeHsm # Methods request :: (Service -> Service) -> DescribeHsm -> Request DescribeHsm # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeHsm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeHsm))) #
Generic DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Associated Types type Rep DescribeHsm :: Type -> Type # Methods from :: DescribeHsm -> Rep DescribeHsm x # to :: Rep DescribeHsm x -> DescribeHsm #
Read DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods readsPrec :: Int -> ReadS DescribeHsm # readList :: ReadS [DescribeHsm] # readPrec :: ReadPrec DescribeHsm # readListPrec :: ReadPrec [DescribeHsm] #
Show DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods showsPrec :: Int -> DescribeHsm -> ShowS # show :: DescribeHsm -> String # showList :: [DescribeHsm] -> ShowS #
NFData DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods rnf :: DescribeHsm -> () #
Eq DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods (==) :: DescribeHsm -> DescribeHsm -> Bool # (/=) :: DescribeHsm -> DescribeHsm -> Bool #
Hashable DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods hashWithSalt :: Int -> DescribeHsm -> Int # hash :: DescribeHsm -> Int #
type AWSResponse DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm type AWSResponse DescribeHsm = DescribeHsmResponse
type Rep DescribeHsm Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm type Rep DescribeHsm = D1 ('MetaData "DescribeHsm" "Amazonka.CloudHSM.DescribeHsm" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "DescribeHsm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hsmSerialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeHsm :: DescribeHsm Source #

Create a value of DescribeHsm with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeHsm, describeHsm_hsmArn - The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

$sel:hsmSerialNumber:DescribeHsm', describeHsm_hsmSerialNumber - The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

Request Lenses

describeHsm_hsmArn :: Lens' DescribeHsm (Maybe Text) Source #

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

describeHsm_hsmSerialNumber :: Lens' DescribeHsm (Maybe Text) Source #

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

Destructuring the Response

data DescribeHsmResponse Source #

Contains the output of the DescribeHsm operation.

See: newDescribeHsmResponse smart constructor.

Constructors

DescribeHsmResponse'

Fields

availabilityZone :: Maybe Text
The Availability Zone that the HSM is in.
eniId :: Maybe Text
The identifier of the elastic network interface (ENI) attached to the HSM.
eniIp :: Maybe Text
The IP address assigned to the HSM's ENI.
hsmArn :: Maybe Text
The ARN of the HSM.
hsmType :: Maybe Text
The HSM model type.
iamRoleArn :: Maybe Text
The ARN of the IAM role assigned to the HSM.
partitions :: Maybe [Text]
The list of partitions on the HSM.
serialNumber :: Maybe Text
The serial number of the HSM.
serverCertLastUpdated :: Maybe Text
The date and time that the server certificate was last updated.
serverCertUri :: Maybe Text
The URI of the certificate server.
softwareVersion :: Maybe Text
The HSM software version.
sshKeyLastUpdated :: Maybe Text
The date and time that the SSH key was last updated.
sshPublicKey :: Maybe Text
The public SSH key.
status :: Maybe HsmStatus
The status of the HSM.
statusDetails :: Maybe Text
Contains additional information about the status of the HSM.
subnetId :: Maybe Text
The identifier of the subnet that the HSM is in.
subscriptionEndDate :: Maybe Text
The subscription end date.
subscriptionStartDate :: Maybe Text
The subscription start date.
subscriptionType :: Maybe SubscriptionType
vendorName :: Maybe Text
The name of the HSM vendor.
vpcId :: Maybe Text
The identifier of the VPC that the HSM is in.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Associated Types type Rep DescribeHsmResponse :: Type -> Type # Methods from :: DescribeHsmResponse -> Rep DescribeHsmResponse x # to :: Rep DescribeHsmResponse x -> DescribeHsmResponse #
Read DescribeHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods readsPrec :: Int -> ReadS DescribeHsmResponse # readList :: ReadS [DescribeHsmResponse] # readPrec :: ReadPrec DescribeHsmResponse # readListPrec :: ReadPrec [DescribeHsmResponse] #
Show DescribeHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods showsPrec :: Int -> DescribeHsmResponse -> ShowS # show :: DescribeHsmResponse -> String # showList :: [DescribeHsmResponse] -> ShowS #
NFData DescribeHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods rnf :: DescribeHsmResponse -> () #
Eq DescribeHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm Methods (==) :: DescribeHsmResponse -> DescribeHsmResponse -> Bool # (/=) :: DescribeHsmResponse -> DescribeHsmResponse -> Bool #
type Rep DescribeHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHsm type Rep DescribeHsmResponse = D1 ('MetaData "DescribeHsmResponse" "Amazonka.CloudHSM.DescribeHsm" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "DescribeHsmResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eniId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "eniIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hsmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hsmType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "partitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "serialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "serverCertLastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serverCertUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "softwareVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "sshKeyLastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sshPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HsmStatus)) :: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "subscriptionEndDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subscriptionStartDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subscriptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SubscriptionType)))) :: (S1 ('MetaSel ('Just "vendorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))