Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.APIGateway.UpdateClientCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about an ClientCertificate resource.

Creating a Request

updateClientCertificate #

Arguments

:: Text	`uccClientCertificateId`
-> UpdateClientCertificate

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

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

uccPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
uccClientCertificateId - [Required] The identifier of the ClientCertificate resource to be updated.

data UpdateClientCertificate #

A request to change information about an ClientCertificate resource.

See: updateClientCertificate smart constructor.

Instances

Eq UpdateClientCertificate #
Methods (==) :: UpdateClientCertificate -> UpdateClientCertificate -> Bool # (/=) :: UpdateClientCertificate -> UpdateClientCertificate -> Bool #
Data UpdateClientCertificate #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateClientCertificate -> c UpdateClientCertificate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateClientCertificate # toConstr :: UpdateClientCertificate -> Constr # dataTypeOf :: UpdateClientCertificate -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateClientCertificate) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateClientCertificate) # gmapT :: (forall b. Data b => b -> b) -> UpdateClientCertificate -> UpdateClientCertificate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateClientCertificate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateClientCertificate -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateClientCertificate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateClientCertificate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateClientCertificate -> m UpdateClientCertificate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateClientCertificate -> m UpdateClientCertificate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateClientCertificate -> m UpdateClientCertificate #
Read UpdateClientCertificate #
Methods readsPrec :: Int -> ReadS UpdateClientCertificate # readList :: ReadS [UpdateClientCertificate] # readPrec :: ReadPrec UpdateClientCertificate # readListPrec :: ReadPrec [UpdateClientCertificate] #
Show UpdateClientCertificate #
Methods showsPrec :: Int -> UpdateClientCertificate -> ShowS # show :: UpdateClientCertificate -> String # showList :: [UpdateClientCertificate] -> ShowS #
Generic UpdateClientCertificate #
Associated Types type Rep UpdateClientCertificate :: * -> * # Methods from :: UpdateClientCertificate -> Rep UpdateClientCertificate x # to :: Rep UpdateClientCertificate x -> UpdateClientCertificate #
Hashable UpdateClientCertificate #
Methods hashWithSalt :: Int -> UpdateClientCertificate -> Int # hash :: UpdateClientCertificate -> Int #
ToJSON UpdateClientCertificate #
Methods toJSON :: UpdateClientCertificate -> Value # toEncoding :: UpdateClientCertificate -> Encoding # toJSONList :: [UpdateClientCertificate] -> Value # toEncodingList :: [UpdateClientCertificate] -> Encoding #
NFData UpdateClientCertificate #
Methods rnf :: UpdateClientCertificate -> () #
AWSRequest UpdateClientCertificate #
Associated Types type Rs UpdateClientCertificate :: * # Methods request :: UpdateClientCertificate -> Request UpdateClientCertificate # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateClientCertificate -> ClientResponse -> m (Response UpdateClientCertificate) #
ToHeaders UpdateClientCertificate #
Methods toHeaders :: UpdateClientCertificate -> [Header] #
ToPath UpdateClientCertificate #
Methods toPath :: UpdateClientCertificate -> ByteString #
ToQuery UpdateClientCertificate #
Methods toQuery :: UpdateClientCertificate -> QueryString #
type Rep UpdateClientCertificate #
type Rep UpdateClientCertificate = D1 * (MetaData "UpdateClientCertificate" "Network.AWS.APIGateway.UpdateClientCertificate" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" False) (C1 * (MetaCons "UpdateClientCertificate'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_uccPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PatchOperation]))) (S1 * (MetaSel (Just Symbol "_uccClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs UpdateClientCertificate #
type Rs UpdateClientCertificate = ClientCertificate

Request Lenses

uccPatchOperations :: Lens' UpdateClientCertificate [PatchOperation] #

A list of update operations to be applied to the specified resource and in the order specified in this list.

uccClientCertificateId :: Lens' UpdateClientCertificate Text #

Required: The identifier of the ClientCertificate resource to be updated.

Destructuring the Response

clientCertificate :: ClientCertificate #

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

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

ccPemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
ccClientCertificateId - The identifier of the client certificate.
ccCreatedDate - The timestamp when the client certificate was created.
ccExpirationDate - The timestamp when the client certificate will expire.
ccDescription - The description of the client certificate.

data ClientCertificate #

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.Use Client-Side Certificate

See: clientCertificate smart constructor.

Instances

Eq ClientCertificate #
Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Data ClientCertificate #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ClientCertificate -> c ClientCertificate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ClientCertificate # toConstr :: ClientCertificate -> Constr # dataTypeOf :: ClientCertificate -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ClientCertificate) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ClientCertificate) # gmapT :: (forall b. Data b => b -> b) -> ClientCertificate -> ClientCertificate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ClientCertificate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ClientCertificate -> r # gmapQ :: (forall d. Data d => d -> u) -> ClientCertificate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ClientCertificate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate #
Read ClientCertificate #
Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate #
Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
Generic ClientCertificate #
Associated Types type Rep ClientCertificate :: * -> * # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
Hashable ClientCertificate #
Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
FromJSON ClientCertificate #
Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
NFData ClientCertificate #
Methods rnf :: ClientCertificate -> () #
type Rep ClientCertificate #
type Rep ClientCertificate = D1 * (MetaData "ClientCertificate" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" False) (C1 * (MetaCons "ClientCertificate'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_ccPemEncodedCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ccClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_ccCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((::) (S1 * (MetaSel (Just Symbol "_ccExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_ccDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

Response Lenses

ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) #

The identifier of the client certificate.

ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) #

The timestamp when the client certificate was created.

ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) #

The timestamp when the client certificate will expire.

ccDescription :: Lens' ClientCertificate (Maybe Text) #

The description of the client certificate.