Skip to content
AWS for Query.Farm

aws.iot1click_projects.describe_project

Example SQL Queries

SELECT * FROM
aws.iot1click_projects.describe_project
WHERE
"project_name" = 'VALUE';

Description

Returns an object describing a project.

Table Definition

Column NameColumn Data Type
project_name Required Input Column

The name of the project to be described.

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.

project

An object describing the project.

STRUCT(
    "arn" VARCHAR,
    "project_name" VARCHAR,
    "description" VARCHAR,
    "created_date" TIMESTAMP_S,
    "updated_date" TIMESTAMP_S,
    "placement_template" STRUCT(
        "default_attributes" MAP(VARCHAR, VARCHAR),
        "device_templates" MAP(VARCHAR, STRUCT(
                "device_type" VARCHAR,
                "callback_overrides" MAP(VARCHAR, VARCHAR)
            ))
    ),
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
project.arn

The ARN of the project.

project.created_date

The date when the project was originally created, in UNIX epoch time format.

project.description

The description of the project.

project.placement_template

An object describing the project's placement specifications.

Show child fields
project.placement_template.default_attributes

The default attributes (key/value pairs) to be applied to all placements using this template.

project.placement_template.device_templates

An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.

project.project_name

The name of the project for which to obtain information from.

project.tags

The tags (metadata key/value pairs) associated with the project.

project.updated_date

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.