Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.UpdateCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the status of the specified certificate. This operation is idempotent.

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Creating a Request

data UpdateCertificate Source #

The input for the UpdateCertificate operation.

See: newUpdateCertificate smart constructor.

Constructors

UpdateCertificate'

Fields

certificateId :: Text
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
newStatus' :: CertificateStatus
The new status.
Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer use.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Instances

Instances details

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

newUpdateCertificate Source #

Arguments

:: Text	`$sel:certificateId:UpdateCertificate'`
-> CertificateStatus	`$sel:newStatus':UpdateCertificate'`
-> UpdateCertificate

Create a value of UpdateCertificate 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:certificateId:UpdateCertificate', updateCertificate_certificateId - The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

$sel:newStatus':UpdateCertificate', updateCertificate_newStatus - The new status.

Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer use.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Request Lenses

updateCertificate_certificateId :: Lens' UpdateCertificate Text Source #

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

updateCertificate_newStatus :: Lens' UpdateCertificate CertificateStatus Source #

The new status.

Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer use.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Destructuring the Response

data UpdateCertificateResponse Source #

See: newUpdateCertificateResponse smart constructor.

Constructors

UpdateCertificateResponse'

Instances

Instances details

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

newUpdateCertificateResponse :: UpdateCertificateResponse Source #

Create a value of UpdateCertificateResponse with all optional fields omitted.

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