Network.AWS.CloudHSM.DescribeHSM

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.

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 - The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
• dhsmHSMARN - The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

data DescribeHSM

Contains the inputs for the DescribeHsm operation.

See: describeHSM smart constructor.

Instances

Eq DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

(==) :: DescribeHSM -> DescribeHSM -> Bool

(/=) :: DescribeHSM -> DescribeHSM -> Bool

Data DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeHSM -> c DescribeHSM

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeHSM

toConstr :: DescribeHSM -> Constr

dataTypeOf :: DescribeHSM -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeHSM)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeHSM)

gmapT :: (forall b. Data b => b -> b) -> DescribeHSM -> DescribeHSM

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSM -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSM -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeHSM -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeHSM -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeHSM -> m DescribeHSM

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSM -> m DescribeHSM

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSM -> m DescribeHSM

Read DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

readsPrec :: Int -> ReadS DescribeHSM

readList :: ReadS [DescribeHSM]

readPrec :: ReadPrec DescribeHSM

readListPrec :: ReadPrec [DescribeHSM]

Show DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

showsPrec :: Int -> DescribeHSM -> ShowS

show :: DescribeHSM -> String

showList :: [DescribeHSM] -> ShowS

Generic DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Associated Types

type Rep DescribeHSM :: Type -> Type

Methods

from :: DescribeHSM -> Rep DescribeHSM x

to :: Rep DescribeHSM x -> DescribeHSM

Hashable DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

hashWithSalt :: Int -> DescribeHSM -> Int

hash :: DescribeHSM -> Int

ToJSON DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

toJSON :: DescribeHSM -> Value

toEncoding :: DescribeHSM -> Encoding

toJSONList :: [DescribeHSM] -> Value

toEncodingList :: [DescribeHSM] -> Encoding

AWSRequest DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Associated Types

type Rs DescribeHSM :: Type

Methods

request :: DescribeHSM -> Request DescribeHSM

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeHSM -> ClientResponse -> m (Response DescribeHSM)

ToHeaders DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

toHeaders :: DescribeHSM -> [Header]

ToPath DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

toPath :: DescribeHSM -> ByteString

ToQuery DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

toQuery :: DescribeHSM -> QueryString

NFData DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

rnf :: DescribeHSM -> ()

type Rep DescribeHSM

Defined in Network.AWS.CloudHSM.DescribeHSM

type Rep DescribeHSM = D1 (MetaData "DescribeHSM" "Network.AWS.CloudHSM.DescribeHSM" "amazonka-cloudhsm-1.6.1-4znIKUA0fUEDSYNWkcPcz3" False) (C1 (MetaCons "DescribeHSM'" PrefixI True) (S1 (MetaSel (Just "_dhsmHSMSerialNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dhsmHSMARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))

type Rs DescribeHSM

Defined in Network.AWS.CloudHSM.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 - The status of the HSM.
• desrsIAMRoleARN - The ARN of the IAM role assigned to the HSM.
• desrsEniId - The identifier of the elastic network interface (ENI) attached to the HSM.
• desrsVPCId - The identifier of the VPC that the HSM is in.
• desrsSSHKeyLastUpdated - The date and time that the SSH key was last updated.
• desrsSubscriptionEndDate - The subscription end date.
• desrsServerCertURI - The URI of the certificate server.
• desrsSubscriptionType - Undocumented member.
• desrsSSHPublicKey - The public SSH key.
• desrsSubnetId - The identifier of the subnet that the HSM is in.
• desrsStatusDetails - Contains additional information about the status of the HSM.
• desrsPartitions - The list of partitions on the HSM.
• desrsSubscriptionStartDate - The subscription start date.
• desrsAvailabilityZone - The Availability Zone that the HSM is in.
• desrsServerCertLastUpdated - The date and time that the server certificate was last updated.
• desrsSoftwareVersion - The HSM software version.
• desrsVendorName - The name of the HSM vendor.
• desrsSerialNumber - The serial number of the HSM.
• desrsHSMARN - The ARN of the HSM.
• desrsEniIP - The IP address assigned to the HSM's ENI.
• desrsHSMType - The HSM model type.
• desrsResponseStatus - -- | The response status code.

data DescribeHSMResponse

Contains the output of the DescribeHsm operation.

See: describeHSMResponse smart constructor.

Instances

Eq DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

(==) :: DescribeHSMResponse -> DescribeHSMResponse -> Bool

(/=) :: DescribeHSMResponse -> DescribeHSMResponse -> Bool

Data DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeHSMResponse -> c DescribeHSMResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeHSMResponse

toConstr :: DescribeHSMResponse -> Constr

dataTypeOf :: DescribeHSMResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeHSMResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeHSMResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeHSMResponse -> DescribeHSMResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSMResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSMResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeHSMResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeHSMResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeHSMResponse -> m DescribeHSMResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSMResponse -> m DescribeHSMResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSMResponse -> m DescribeHSMResponse

Read DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

readsPrec :: Int -> ReadS DescribeHSMResponse

readList :: ReadS [DescribeHSMResponse]

readPrec :: ReadPrec DescribeHSMResponse

readListPrec :: ReadPrec [DescribeHSMResponse]

Show DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

showsPrec :: Int -> DescribeHSMResponse -> ShowS

show :: DescribeHSMResponse -> String

showList :: [DescribeHSMResponse] -> ShowS

Generic DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

Associated Types

type Rep DescribeHSMResponse :: Type -> Type

Methods

from :: DescribeHSMResponse -> Rep DescribeHSMResponse x

to :: Rep DescribeHSMResponse x -> DescribeHSMResponse

NFData DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

Methods

rnf :: DescribeHSMResponse -> ()

type Rep DescribeHSMResponse

Defined in Network.AWS.CloudHSM.DescribeHSM

type Rep DescribeHSMResponse = D1 (MetaData "DescribeHSMResponse" "Network.AWS.CloudHSM.DescribeHSM" "amazonka-cloudhsm-1.6.1-4znIKUA0fUEDSYNWkcPcz3" False) (C1 (MetaCons "DescribeHSMResponse'" PrefixI True) ((((S1 (MetaSel (Just "_desrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe HSMStatus)) :*: S1 (MetaSel (Just "_desrsIAMRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_desrsEniId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsVPCId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsSSHKeyLastUpdated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_desrsSubscriptionEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsServerCertURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsSubscriptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SubscriptionType)))) :*: (S1 (MetaSel (Just "_desrsSSHPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsStatusDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 (MetaSel (Just "_desrsPartitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_desrsSubscriptionStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_desrsAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsServerCertLastUpdated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsSoftwareVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_desrsVendorName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsSerialNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsHSMARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_desrsEniIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsHSMType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

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

Undocumented member.

desrsSSHPublicKey :: Lens' DescribeHSMResponse (Maybe Text)

The public SSH key.

desrsSubnetId :: Lens' DescribeHSMResponse (Maybe Text)

The identifier of the subnet that 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 that 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.