amazonka-iot-1.6.1: Amazon IoT SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IoT.UpdateCertificate

Contents

Description

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

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Synopsis

Creating a Request

updateCertificate #

Creates a value of UpdateCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ucCertificateId - The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
  • ucNewStatus - The new status. Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

data UpdateCertificate #

The input for the UpdateCertificate operation.

See: updateCertificate smart constructor.

Instances
Eq UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Data UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Methods

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

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

toConstr :: UpdateCertificate -> Constr #

dataTypeOf :: UpdateCertificate -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> UpdateCertificate -> UpdateCertificate #

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

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

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

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

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

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

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

Read UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Show UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Generic UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Associated Types

type Rep UpdateCertificate :: Type -> Type #

Hashable UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

ToJSON UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

AWSRequest UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Associated Types

type Rs UpdateCertificate :: Type #

ToHeaders UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

ToPath UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

ToQuery UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

NFData UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Methods

rnf :: UpdateCertificate -> () #

type Rep UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

type Rep UpdateCertificate = D1 (MetaData "UpdateCertificate" "Network.AWS.IoT.UpdateCertificate" "amazonka-iot-1.6.1-nGAJeezEdVLHUPuibI4m" False) (C1 (MetaCons "UpdateCertificate'" PrefixI True) (S1 (MetaSel (Just "_ucCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ucNewStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CertificateStatus)))
type Rs UpdateCertificate # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Request Lenses

ucCertificateId :: Lens' UpdateCertificate Text #

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

ucNewStatus :: Lens' UpdateCertificate CertificateStatus #

The new status. Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Destructuring the Response

updateCertificateResponse :: UpdateCertificateResponse #

Creates a value of UpdateCertificateResponse with the minimum fields required to make a request.

data UpdateCertificateResponse #

See: updateCertificateResponse smart constructor.

Instances
Eq UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Data UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Methods

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

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

toConstr :: UpdateCertificateResponse -> Constr #

dataTypeOf :: UpdateCertificateResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> UpdateCertificateResponse -> UpdateCertificateResponse #

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

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

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

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

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

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

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

Read UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Show UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Generic UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

Associated Types

type Rep UpdateCertificateResponse :: Type -> Type #

NFData UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

type Rep UpdateCertificateResponse # 
Instance details

Defined in Network.AWS.IoT.UpdateCertificate

type Rep UpdateCertificateResponse = D1 (MetaData "UpdateCertificateResponse" "Network.AWS.IoT.UpdateCertificate" "amazonka-iot-1.6.1-nGAJeezEdVLHUPuibI4m" False) (C1 (MetaCons "UpdateCertificateResponse'" PrefixI False) (U1 :: Type -> Type))