Skip to content
AWS for Query.Farm

aws.imagebuilder.get_component

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_component
WHERE
"component_build_version_arn" = 'VALUE';

Description

Gets a component object.

Table Definition

Column NameColumn Data Type
component_build_version_arn Required Input Column

The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix /\d+$.

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

The component object specified in the request.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "version" VARCHAR,
    "description" VARCHAR,
    "change_description" VARCHAR,
    "type" VARCHAR,
    "platform" VARCHAR,
    "supported_os_versions" VARCHAR[],
    "state" STRUCT(
        "status" VARCHAR,
        "reason" VARCHAR
    ),
    "parameters" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR,
        "default_value" VARCHAR[],
        "description" VARCHAR
    )[],
    "owner" VARCHAR,
    "data" VARCHAR,
    "kms_key_id" VARCHAR,
    "encrypted" BOOLEAN,
    "date_created" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "publisher" VARCHAR,
    "obfuscate" BOOLEAN
)
Show child fields
component.arn

The Amazon Resource Name (ARN) of the component.

component.change_description

Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

component.data

Component data contains the YAML document content for the component.

component.date_created

The date that Image Builder created the component.

component.description

The description of the component.

component.encrypted

The encryption status of the component.

component.kms_key_id

The KMS key identifier used to encrypt the component.

component.name

The name of the component.

component.obfuscate

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

component.owner

The owner of the component.

component.parameters[]
Show child fields
component.parameters[].default_value[]
component.parameters[].description

Describes this parameter.

component.parameters[].name

The name of this input parameter.

component.parameters[].type

The type of input this parameter provides. The currently supported value is "string".

component.platform

The operating system platform of the component.

component.publisher

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

component.state

Describes the current status of the component. This is used for components that are no longer active.

Show child fields
component.state.reason

Describes how or why the component changed state.

component.state.status

The current state of the component.

component.supported_os_versions[]
component.tags

The tags that apply to the component.

component.type

The component type specifies whether Image Builder uses the component to build the image or only to test it.

component.version

The version of the component.

request_id

The request ID that uniquely identifies this request.

VARCHAR