Skip to content
AWS for Query.Farm

aws.iot.describe_domain_configuration

Example SQL Queries

SELECT * FROM
aws.iot.describe_domain_configuration
WHERE
"domain_configuration_name" = 'VALUE';

Description

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

Table Definition

Column NameColumn Data Type
domain_configuration_name Required Input Column

The name of the domain configuration.

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
authorizer_config

An object that specifies the authorization service for a domain.

STRUCT(
    "default_authorizer_name" VARCHAR,
    "allow_authorizer_override" BOOLEAN
)
Show child fields
authorizer_config.allow_authorizer_override

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

authorizer_config.default_authorizer_name

The name of the authorization service for a domain configuration.

domain_configuration_arn

The ARN of the domain configuration.

VARCHAR
domain_configuration_status

A Boolean value that specifies the current state of the domain configuration.

VARCHAR
domain_name

The name of the domain.

VARCHAR
domain_type

The type of the domain.

VARCHAR
last_status_change_date

The date and time the domain configuration's status was last changed.

TIMESTAMP_S
server_certificate_config

The server certificate configuration.

STRUCT(
    "enable_ocsp_check" BOOLEAN
)
Show child fields
server_certificate_config.enable_ocsp_check

A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not.

For more information, see Configuring OCSP server-certificate stapling in domain configuration from Amazon Web Services IoT Core Developer Guide.

server_certificates

A list containing summary information about the server certificate included in the domain configuration.

STRUCT(
    "server_certificate_arn" VARCHAR,
    "server_certificate_status" VARCHAR,
    "server_certificate_status_detail" VARCHAR
)[]
Show child fields
server_certificates[]
Show child fields
server_certificates[].server_certificate_arn

The ARN of the server certificate.

server_certificates[].server_certificate_status

The status of the server certificate.

server_certificates[].server_certificate_status_detail

Details that explain the status of the server certificate.

service_type

The type of service delivered by the endpoint.

VARCHAR
tls_config

An object that specifies the TLS configuration for a domain.

STRUCT(
    "security_policy" VARCHAR
)
Show child fields
tls_config.security_policy

The security policy for a domain configuration. For more information, see Security policies in the Amazon Web Services IoT Core developer guide.