amazonka-apigateway-1.6.0: Amazon API Gateway 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.APIGateway.UpdateClientCertificate

Contents

Description

Changes information about an ClientCertificate resource.

Synopsis

Creating a Request

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:

data UpdateClientCertificate #

A request to change information about an ClientCertificate resource.

See: updateClientCertificate smart constructor.

Instances
Eq UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

Data UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.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 # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

Show UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

Generic UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

Associated Types

type Rep UpdateClientCertificate :: * -> * #

Hashable UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

ToJSON UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

AWSRequest UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

Associated Types

type Rs UpdateClientCertificate :: * #

ToHeaders UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

ToPath UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

ToQuery UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

NFData UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

Methods

rnf :: UpdateClientCertificate -> () #

type Rep UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

type Rep UpdateClientCertificate = D1 (MetaData "UpdateClientCertificate" "Network.AWS.APIGateway.UpdateClientCertificate" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "UpdateClientCertificate'" PrefixI True) (S1 (MetaSel (Just "_uccPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 (MetaSel (Just "_uccClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs UpdateClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.UpdateClientCertificate

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 # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Data ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

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 # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Show ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Generic ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep ClientCertificate :: * -> * #

Hashable ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

FromJSON ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

NFData ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: ClientCertificate -> () #

type Rep ClientCertificate # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

type Rep ClientCertificate = D1 (MetaData "ClientCertificate" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "ClientCertificate'" PrefixI True) ((S1 (MetaSel (Just "_ccPemEncodedCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ccCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 (MetaSel (Just "_ccExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_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.