Copyright	(c) 2013-2021 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

Amazonka.APIGateway.UpdateClientCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about an ClientCertificate resource.

Synopsis

data UpdateClientCertificate = UpdateClientCertificate' {
- patchOperations :: Maybe [PatchOperation]
- clientCertificateId :: Text
}
newUpdateClientCertificate :: Text -> UpdateClientCertificate
updateClientCertificate_patchOperations :: Lens' UpdateClientCertificate (Maybe [PatchOperation])
updateClientCertificate_clientCertificateId :: Lens' UpdateClientCertificate Text
data ClientCertificate = ClientCertificate' {
- pemEncodedCertificate :: Maybe Text
- clientCertificateId :: Maybe Text
- createdDate :: Maybe POSIX
- expirationDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newClientCertificate :: ClientCertificate
clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text)
clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text)
clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime)
clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime)
clientCertificate_description :: Lens' ClientCertificate (Maybe Text)
clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text))

Creating a Request

data UpdateClientCertificate Source #

A request to change information about an ClientCertificate resource.

See: newUpdateClientCertificate smart constructor.

Constructors

UpdateClientCertificate'
Fields patchOperations :: Maybe [PatchOperation] A list of update operations to be applied to the specified resource and in the order specified in this list. clientCertificateId :: Text Required The identifier of the ClientCertificate resource to be updated.

Instances

Instances details

Eq UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods (==) :: UpdateClientCertificate -> UpdateClientCertificate -> Bool # (/=) :: UpdateClientCertificate -> UpdateClientCertificate -> Bool #
Read UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods readsPrec :: Int -> ReadS UpdateClientCertificate # readList :: ReadS [UpdateClientCertificate] # readPrec :: ReadPrec UpdateClientCertificate # readListPrec :: ReadPrec [UpdateClientCertificate] #
Show UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods showsPrec :: Int -> UpdateClientCertificate -> ShowS # show :: UpdateClientCertificate -> String # showList :: [UpdateClientCertificate] -> ShowS #
Generic UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Associated Types type Rep UpdateClientCertificate :: Type -> Type # Methods from :: UpdateClientCertificate -> Rep UpdateClientCertificate x # to :: Rep UpdateClientCertificate x -> UpdateClientCertificate #
NFData UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods rnf :: UpdateClientCertificate -> () #
Hashable UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods hashWithSalt :: Int -> UpdateClientCertificate -> Int # hash :: UpdateClientCertificate -> Int #
ToJSON UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toJSON :: UpdateClientCertificate -> Value # toEncoding :: UpdateClientCertificate -> Encoding # toJSONList :: [UpdateClientCertificate] -> Value # toEncodingList :: [UpdateClientCertificate] -> Encoding #
AWSRequest UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Associated Types type AWSResponse UpdateClientCertificate # Methods request :: UpdateClientCertificate -> Request UpdateClientCertificate # response :: MonadResource m => Logger -> Service -> Proxy UpdateClientCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateClientCertificate))) #
ToHeaders UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toHeaders :: UpdateClientCertificate -> [Header] #
ToPath UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toPath :: UpdateClientCertificate -> ByteString #
ToQuery UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toQuery :: UpdateClientCertificate -> QueryString #
type Rep UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate type Rep UpdateClientCertificate = D1 ('MetaData "UpdateClientCertificate" "Amazonka.APIGateway.UpdateClientCertificate" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateClientCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate type AWSResponse UpdateClientCertificate = ClientCertificate

newUpdateClientCertificate Source #

Arguments

:: Text	`$sel:clientCertificateId:UpdateClientCertificate'`
-> UpdateClientCertificate

Create a value of UpdateClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateClientCertificate', updateClientCertificate_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:clientCertificateId:UpdateClientCertificate', updateClientCertificate_clientCertificateId - [Required] The identifier of the ClientCertificate resource to be updated.

Request Lenses

updateClientCertificate_patchOperations :: Lens' UpdateClientCertificate (Maybe [PatchOperation]) Source #

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

updateClientCertificate_clientCertificateId :: Lens' UpdateClientCertificate Text Source #

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

Destructuring the Response

data ClientCertificate Source #

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: newClientCertificate smart constructor.

Constructors

ClientCertificate'

Fields

pemEncodedCertificate :: Maybe Text
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
clientCertificateId :: Maybe Text
The identifier of the client certificate.
createdDate :: Maybe POSIX
The timestamp when the client certificate was created.
expirationDate :: Maybe POSIX
The timestamp when the client certificate will expire.
description :: Maybe Text
The description of the client certificate.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.

Instances

Instances details

Eq ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Read ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
Generic ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Associated Types type Rep ClientCertificate :: Type -> Type # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
NFData ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods rnf :: ClientCertificate -> () #
Hashable ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
FromJSON ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
type Rep ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate type Rep ClientCertificate = D1 ('MetaData "ClientCertificate" "Amazonka.APIGateway.Types.ClientCertificate" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "ClientCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pemEncodedCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newClientCertificate :: ClientCertificate Source #

Create a value of ClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.

$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.

$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.

$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.

$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

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

clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.