Skip to content
AWS for Query.Farm

aws.iot.describe_certificate

Example SQL Queries

SELECT * FROM
aws.iot.describe_certificate
WHERE
"certificate_id" = 'VALUE';

Description

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Table Definition

Column NameColumn Data Type
certificate_id Required Input Column

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
certificate_description

The description of the certificate.

STRUCT(
    "certificate_arn" VARCHAR,
    "certificate_id" VARCHAR,
    "ca_certificate_id" VARCHAR,
    "status" VARCHAR,
    "certificate_pem" VARCHAR,
    "owned_by" VARCHAR,
    "previous_owned_by" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "last_modified_date" TIMESTAMP_S,
    "customer_version" BIGINT,
    "transfer_data" STRUCT(
        "transfer_message" VARCHAR,
        "reject_reason" VARCHAR,
        "transfer_date" TIMESTAMP_S,
        "accept_date" TIMESTAMP_S,
        "reject_date" TIMESTAMP_S
    ),
    "generation_id" VARCHAR,
    "validity" STRUCT(
        "not_before" TIMESTAMP_S,
        "not_after" TIMESTAMP_S
    ),
    "certificate_mode" VARCHAR
)
Show child fields
certificate_description.ca_certificate_id

The certificate ID of the CA certificate used to sign this certificate.

certificate_description.certificate_arn

The ARN of the certificate.

certificate_description.certificate_id

The ID of the certificate.

certificate_description.certificate_mode

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.

For more information about the value for SNI extension, see Transport security in IoT.

certificate_description.certificate_pem

The certificate data, in PEM format.

certificate_description.creation_date

The date and time the certificate was created.

certificate_description.customer_version

The customer version of the certificate.

certificate_description.generation_id

The generation ID of the certificate.

certificate_description.last_modified_date

The date and time the certificate was last modified.

certificate_description.owned_by

The ID of the Amazon Web Services account that owns the certificate.

certificate_description.previous_owned_by

The ID of the Amazon Web Services account of the previous owner of the certificate.

certificate_description.status

The status of the certificate.

certificate_description.transfer_data

The transfer data.

Show child fields
certificate_description.transfer_data.accept_date

The date the transfer was accepted.

certificate_description.transfer_data.reject_date

The date the transfer was rejected.

certificate_description.transfer_data.reject_reason

The reason why the transfer was rejected.

certificate_description.transfer_data.transfer_date

The date the transfer took place.

certificate_description.transfer_data.transfer_message

The transfer message.

certificate_description.validity

When the certificate is valid.

Show child fields
certificate_description.validity.not_after

The certificate is not valid after this date.

certificate_description.validity.not_before

The certificate is not valid before this date.