Skip to content
AWS for Query.Farm

aws.iot.describe_provisioning_template

Example SQL Queries

SELECT * FROM
aws.iot.describe_provisioning_template
WHERE
"template_name" = 'VALUE';

Description

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

Table Definition

Column NameColumn Data Type
template_name Required Input Column

The name of the provisioning template.

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
creation_date

The date when the provisioning template was created.

TIMESTAMP_S
default_version_id

The default fleet template version ID.

BIGINT
description

The description of the provisioning template.

VARCHAR
enabled

True if the provisioning template is enabled, otherwise false.

BOOLEAN
last_modified_date

The date when the provisioning template was last modified.

TIMESTAMP_S
pre_provisioning_hook

Gets information about a pre-provisioned hook.

STRUCT(
    "payload_version" VARCHAR,
    "target_arn" VARCHAR
)
Show child fields
pre_provisioning_hook.payload_version

The payload that was sent to the target function.

Note: Only Lambda functions are currently supported.

pre_provisioning_hook.target_arn

The ARN of the target function.

Note: Only Lambda functions are currently supported.

provisioning_role_arn

The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

VARCHAR
template_arn

The ARN of the provisioning template.

VARCHAR
template_body

The JSON formatted contents of the provisioning template.

VARCHAR
type

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template. 

VARCHAR