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.IoT.DeleteCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.

Requires permission to access the DeleteCertificate action.

Creating a Request

data DeleteCertificate Source #

The input for the DeleteCertificate operation.

See: newDeleteCertificate smart constructor.

Constructors

DeleteCertificate'
Fields forceDelete :: Maybe Bool Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing. certificateId :: Text The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Instances

Instances details

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

newDeleteCertificate Source #

Arguments

:: Text	`DeleteCertificate`
-> DeleteCertificate

Create a value of DeleteCertificate 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:forceDelete:DeleteCertificate', deleteCertificate_forceDelete - Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

DeleteCertificate, deleteCertificate_certificateId - The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Request Lenses

deleteCertificate_forceDelete :: Lens' DeleteCertificate (Maybe Bool) Source #

Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

deleteCertificate_certificateId :: Lens' DeleteCertificate Text Source #

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Destructuring the Response

data DeleteCertificateResponse Source #

See: newDeleteCertificateResponse smart constructor.

Constructors

DeleteCertificateResponse'

Instances

Instances details

Generic DeleteCertificateResponse Source #
Instance details Defined in Amazonka.IoT.DeleteCertificate Associated Types type Rep DeleteCertificateResponse :: Type -> Type # Methods from :: DeleteCertificateResponse -> Rep DeleteCertificateResponse x # to :: Rep DeleteCertificateResponse x -> DeleteCertificateResponse #
Read DeleteCertificateResponse Source #
Instance details Defined in Amazonka.IoT.DeleteCertificate Methods readsPrec :: Int -> ReadS DeleteCertificateResponse # readList :: ReadS [DeleteCertificateResponse] # readPrec :: ReadPrec DeleteCertificateResponse # readListPrec :: ReadPrec [DeleteCertificateResponse] #
Show DeleteCertificateResponse Source #
Instance details Defined in Amazonka.IoT.DeleteCertificate Methods showsPrec :: Int -> DeleteCertificateResponse -> ShowS # show :: DeleteCertificateResponse -> String # showList :: [DeleteCertificateResponse] -> ShowS #
NFData DeleteCertificateResponse Source #
Instance details Defined in Amazonka.IoT.DeleteCertificate Methods rnf :: DeleteCertificateResponse -> () #
Eq DeleteCertificateResponse Source #
Instance details Defined in Amazonka.IoT.DeleteCertificate Methods (==) :: DeleteCertificateResponse -> DeleteCertificateResponse -> Bool # (/=) :: DeleteCertificateResponse -> DeleteCertificateResponse -> Bool #
type Rep DeleteCertificateResponse Source #
Instance details Defined in Amazonka.IoT.DeleteCertificate type Rep DeleteCertificateResponse = D1 ('MetaData "DeleteCertificateResponse" "Amazonka.IoT.DeleteCertificate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DeleteCertificateResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteCertificateResponse :: DeleteCertificateResponse Source #

Create a value of DeleteCertificateResponse with all optional fields omitted.

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