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.GetClientCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the current ClientCertificate resource.

Creating a Request

getClientCertificate #

Arguments

:: Text	`gccClientCertificateId`
-> GetClientCertificate

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

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

gccClientCertificateId - [Required] The identifier of the ClientCertificate resource to be described.

data GetClientCertificate #

A request to get information about the current ClientCertificate resource.

See: getClientCertificate smart constructor.

Instances

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

Request Lenses

gccClientCertificateId :: Lens' GetClientCertificate Text #

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

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.