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.DeleteHsm

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.

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Synopsis

data DeleteHsm = DeleteHsm' {
- hsmArn :: Text
}
newDeleteHsm :: Text -> DeleteHsm
deleteHsm_hsmArn :: Lens' DeleteHsm Text
data DeleteHsmResponse = DeleteHsmResponse' {
- httpStatus :: Int
- status :: Text
}
newDeleteHsmResponse :: Int -> Text -> DeleteHsmResponse
deleteHsmResponse_httpStatus :: Lens' DeleteHsmResponse Int
deleteHsmResponse_status :: Lens' DeleteHsmResponse Text

Creating a Request

data DeleteHsm Source #

Contains the inputs for the DeleteHsm operation.

See: newDeleteHsm smart constructor.

Constructors

DeleteHsm'
Fields hsmArn :: Text The ARN of the HSM to delete.

Instances

Instances details

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

newDeleteHsm Source #

Arguments

:: Text	`$sel:hsmArn:DeleteHsm'`
-> DeleteHsm

Create a value of DeleteHsm 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:

$sel:hsmArn:DeleteHsm', deleteHsm_hsmArn - The ARN of the HSM to delete.

Request Lenses

deleteHsm_hsmArn :: Lens' DeleteHsm Text Source #

The ARN of the HSM to delete.

Destructuring the Response

data DeleteHsmResponse Source #

Contains the output of the DeleteHsm operation.

See: newDeleteHsmResponse smart constructor.

Constructors

DeleteHsmResponse'
Fields httpStatus :: Int The response's http status code. status :: Text The status of the operation.

Instances

Instances details

Generic DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DeleteHsm Associated Types type Rep DeleteHsmResponse :: Type -> Type # Methods from :: DeleteHsmResponse -> Rep DeleteHsmResponse x # to :: Rep DeleteHsmResponse x -> DeleteHsmResponse #
Read DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DeleteHsm Methods readsPrec :: Int -> ReadS DeleteHsmResponse # readList :: ReadS [DeleteHsmResponse] # readPrec :: ReadPrec DeleteHsmResponse # readListPrec :: ReadPrec [DeleteHsmResponse] #
Show DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DeleteHsm Methods showsPrec :: Int -> DeleteHsmResponse -> ShowS # show :: DeleteHsmResponse -> String # showList :: [DeleteHsmResponse] -> ShowS #
NFData DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DeleteHsm Methods rnf :: DeleteHsmResponse -> () #
Eq DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DeleteHsm Methods (==) :: DeleteHsmResponse -> DeleteHsmResponse -> Bool # (/=) :: DeleteHsmResponse -> DeleteHsmResponse -> Bool #
type Rep DeleteHsmResponse Source #
Instance details Defined in Amazonka.CloudHSM.DeleteHsm type Rep DeleteHsmResponse = D1 ('MetaData "DeleteHsmResponse" "Amazonka.CloudHSM.DeleteHsm" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "DeleteHsmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteHsmResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteHsmResponse'`
-> Text	`$sel:status:DeleteHsmResponse'`
-> DeleteHsmResponse

Create a value of DeleteHsmResponse 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:

$sel:httpStatus:DeleteHsmResponse', deleteHsmResponse_httpStatus - The response's http status code.

$sel:status:DeleteHsmResponse', deleteHsmResponse_status - The status of the operation.

Response Lenses

deleteHsmResponse_httpStatus :: Lens' DeleteHsmResponse Int Source #

The response's http status code.

deleteHsmResponse_status :: Lens' DeleteHsmResponse Text Source #

The status of the operation.