Skip to content
AWS for Query.Farm

aws.greengrassv2.describe_component

Example SQL Queries

SELECT * FROM
aws.greengrassv2.describe_component
WHERE
"arn" = 'VALUE';

Description

Retrieves metadata for a version of a component.

Table Definition

Column NameColumn Data Type
arn Required Input Column

The ARN of the component version.

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.

component_name

The name of the component.

VARCHAR
component_version

The version of the component.

VARCHAR
creation_timestamp

The time at which the component was created, expressed in ISO 8601 format.

TIMESTAMP_S
description

The description of the component version.

VARCHAR
platforms

The platforms that the component version supports.

STRUCT(
    "name" VARCHAR,
    "attributes" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
platforms[]
Show child fields
platforms[].attributes

A dictionary of attributes for the platform. The IoT Greengrass Core software defines the os and architecture by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

platforms[].name

The friendly name of the platform. This name helps you identify the platform.

If you omit this parameter, IoT Greengrass creates a friendly name from the os and architecture of the platform.

publisher

The publisher of the component version.

VARCHAR
status

The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.

STRUCT(
    "component_state" VARCHAR,
    "message" VARCHAR,
    "errors" MAP(VARCHAR, VARCHAR),
    "vendor_guidance" VARCHAR,
    "vendor_guidance_message" VARCHAR
)
Show child fields
status.component_state

The state of the component version.

status.errors

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

status.message

A message that communicates details, such as errors, about the status of the component version.

status.vendor_guidance

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

  • ACTIVE – This component version is available and recommended for use.

  • DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

  • DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

status.vendor_guidance_message

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

tags

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

MAP(VARCHAR, VARCHAR)