client_certificates

Creates, updates, deletes, gets or lists a client_certificates resource.

Overview

Name	client_certificates
Type	Resource
Id	aws.apigateway.client_certificates

Fields

The following fields are returned by SELECT queries:

get_client_certificate

Name	Datatype	Description
client_certificate_id	string	The identifier of the client certificate.
created_date	string (date-time)	The timestamp when the client certificate was created.
description	string	The description of the client certificate.
expiration_date	string (date-time)	The timestamp when the client certificate will expire.
pem_encoded_certificate	string	The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
tags	object	The collection of tags. Each tag element is associated with a given resource.

get_client_certificates

Name	Datatype	Description
client_certificate_id	string	The identifier of the client certificate.
created_date	string (date-time)	The timestamp when the client certificate was created.
description	string	The description of the client certificate.
expiration_date	string (date-time)	The timestamp when the client certificate will expire.
pem_encoded_certificate	string	The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
tags	object	The collection of tags. Each tag element is associated with a given resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_client_certificate	select	clientcertificate_id, region		Gets information about the current ClientCertificate resource.
get_client_certificates	select	region	position, limit	Gets a collection of ClientCertificate resources.
update_client_certificate	update	clientcertificate_id, region		Changes information about an ClientCertificate resource.
delete_client_certificate	delete	clientcertificate_id, region		Deletes the ClientCertificate resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clientcertificate_id	string	The identifier of the ClientCertificate resource to be deleted.
region	string	AWS region (default: us-east-1)
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.

SELECT examples

get_client_certificate

Gets information about the current ClientCertificate resource.

SELECT
client_certificate_id,
created_date,
description,
expiration_date,
pem_encoded_certificate,
tags
FROM aws.apigateway.client_certificates
WHERE clientcertificate_id = '{{ clientcertificate_id }}' -- required
AND region = '{{ region }}' -- required
;

get_client_certificates

Gets a collection of ClientCertificate resources.

SELECT
client_certificate_id,
created_date,
description,
expiration_date,
pem_encoded_certificate,
tags
FROM aws.apigateway.client_certificates
WHERE region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
;

UPDATE examples

update_client_certificate

Changes information about an ClientCertificate resource.

UPDATE aws.apigateway.client_certificates
SET 
patchOperations = '{{ patchOperations }}'
WHERE 
clientcertificate_id = '{{ clientcertificate_id }}' --required
AND region = '{{ region }}' --required
RETURNING
client_certificate_id,
created_date,
description,
expiration_date,
pem_encoded_certificate,
tags;

DELETE examples

delete_client_certificate

Deletes the ClientCertificate resource.

DELETE FROM aws.apigateway.client_certificates
WHERE clientcertificate_id = '{{ clientcertificate_id }}' --required
AND region = '{{ region }}' --required
;