certificates_by_cas
Creates, updates, deletes, gets or lists a certificates_by_cas resource.
Overview
| Name | certificates_by_cas |
| Type | Resource |
| Id | aws.iot.certificates_by_cas |
Fields
The following fields are returned by SELECT queries:
- list_certificates_by_ca
| Name | Datatype | Description |
|---|---|---|
certificate_arn | string | The ARN of the certificate. |
certificate_id | string | The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) (pattern: <code>(0x)?[a-fA-F0-9]+</code>) |
certificate_mode | string | The mode of the certificate. DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core. SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core. (DEFAULT, SNI_ONLY) |
creation_date | string (date-time) | The date and time the certificate was created. |
status | string | The status of the certificate. The status value REGISTER_INACTIVE is deprecated and should not be used. (ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_certificates_by_ca | select | ca_certificate_id, region | pageSize, marker, isAscendingOrder | List the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action. |
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 |
|---|---|---|
ca_certificate_id | string | The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate. |
region | string | AWS region (default: us-east-1) |
isAscendingOrder | boolean | Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. |
marker | string | The marker for the next set of results. |
pageSize | integer | The result page size. |
SELECT examples
- list_certificates_by_ca
List the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action.
SELECT
certificate_arn,
certificate_id,
certificate_mode,
creation_date,
status
FROM aws.iot.certificates_by_cas
WHERE ca_certificate_id = '{{ ca_certificate_id }}' -- required
AND region = '{{ region }}' -- required
AND pageSize = '{{ pageSize }}'
AND marker = '{{ marker }}'
AND isAscendingOrder = '{{ isAscendingOrder }}'
;