Network.AWS.APIGateway.GetClientCertificate

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

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

(==) :: GetClientCertificate -> GetClientCertificate -> Bool

(/=) :: GetClientCertificate -> GetClientCertificate -> Bool

Data GetClientCertificate

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

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

readsPrec :: Int -> ReadS GetClientCertificate

readList :: ReadS [GetClientCertificate]

readPrec :: ReadPrec GetClientCertificate

readListPrec :: ReadPrec [GetClientCertificate]

Show GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

showsPrec :: Int -> GetClientCertificate -> ShowS

show :: GetClientCertificate -> String

showList :: [GetClientCertificate] -> ShowS

Generic GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Associated Types

type Rep GetClientCertificate :: Type -> Type

Methods

from :: GetClientCertificate -> Rep GetClientCertificate x

to :: Rep GetClientCertificate x -> GetClientCertificate

Hashable GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

hashWithSalt :: Int -> GetClientCertificate -> Int

hash :: GetClientCertificate -> Int

AWSRequest GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Associated Types

type Rs GetClientCertificate :: Type

Methods

request :: GetClientCertificate -> Request GetClientCertificate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetClientCertificate -> ClientResponse -> m (Response GetClientCertificate)

ToHeaders GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

toHeaders :: GetClientCertificate -> [Header]

ToPath GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

toPath :: GetClientCertificate -> ByteString

ToQuery GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

toQuery :: GetClientCertificate -> QueryString

NFData GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

Methods

rnf :: GetClientCertificate -> ()

type Rep GetClientCertificate

Defined in Network.AWS.APIGateway.GetClientCertificate

type Rep GetClientCertificate = D1 (MetaData "GetClientCertificate" "Network.AWS.APIGateway.GetClientCertificate" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" True) (C1 (MetaCons "GetClientCertificate'" PrefixI True) (S1 (MetaSel (Just "_gccClientCertificateId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs GetClientCertificate

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

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: ClientCertificate -> ClientCertificate -> Bool

(/=) :: ClientCertificate -> ClientCertificate -> Bool

Data ClientCertificate

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

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS ClientCertificate

readList :: ReadS [ClientCertificate]

readPrec :: ReadPrec ClientCertificate

readListPrec :: ReadPrec [ClientCertificate]

Show ClientCertificate

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> ClientCertificate -> ShowS

show :: ClientCertificate -> String

showList :: [ClientCertificate] -> ShowS

Generic ClientCertificate

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep ClientCertificate :: Type -> Type

Methods

from :: ClientCertificate -> Rep ClientCertificate x

to :: Rep ClientCertificate x -> ClientCertificate

Hashable ClientCertificate

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> ClientCertificate -> Int

hash :: ClientCertificate -> Int

FromJSON ClientCertificate

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser ClientCertificate

parseJSONList :: Value -> Parser [ClientCertificate]

NFData ClientCertificate

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: ClientCertificate -> ()

type Rep ClientCertificate

Defined in Network.AWS.APIGateway.Types.Product

type Rep ClientCertificate = D1 (MetaData "ClientCertificate" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" 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.