Skip to content
AWS for Query.Farm

aws.appstream.describe_image_builders

Example SQL Queries

SELECT * FROM
aws.appstream.describe_image_builders;

Description

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

Table Definition

Column NameColumn Data Type
names Input Column

The names of the image builders to describe.

VARCHAR[]
Show child fields
names[]
_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.

access_endpoints

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

STRUCT(
    "endpoint_type" VARCHAR,
    "vpce_id" VARCHAR
)[]
Show child fields
access_endpoints[]
Show child fields
access_endpoints[].endpoint_type

The type of interface endpoint.

access_endpoints[].vpce_id

The identifier (ID) of the VPC in which the interface endpoint is used.

appstream_agent_version

The version of the AppStream 2.0 agent that is currently being used by the image builder. 

VARCHAR
arn

The ARN for the image builder.

VARCHAR
created_time

The time stamp when the image builder was created.

TIMESTAMP_S
description

The description to display.

VARCHAR
display_name

The image builder name to display.

VARCHAR
domain_join_info

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. 

STRUCT(
    "directory_name" VARCHAR,
    "organizational_unit_distinguished_name" VARCHAR
)
Show child fields
domain_join_info.directory_name

The fully qualified name of the directory (for example, corp.example.com).

domain_join_info.organizational_unit_distinguished_name

The distinguished name of the organizational unit for computer accounts.

enable_default_internet_access

Enables or disables default internet access for the image builder.

BOOLEAN
iam_role_arn

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

VARCHAR
image_arn

The ARN of the image from which this builder was created.

VARCHAR
image_builder_errors

The image builder errors.

STRUCT(
    "error_code" VARCHAR,
    "error_message" VARCHAR,
    "error_timestamp" TIMESTAMP_S
)[]
Show child fields
image_builder_errors[]
Show child fields
image_builder_errors[].error_code

The error code.

image_builder_errors[].error_message

The error message.

image_builder_errors[].error_timestamp

The time the error occurred.

instance_type

The instance type for the image builder. The following instance types are available:

  • stream.standard.small

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.memory.z1d.large

  • stream.memory.z1d.xlarge

  • stream.memory.z1d.2xlarge

  • stream.memory.z1d.3xlarge

  • stream.memory.z1d.6xlarge

  • stream.memory.z1d.12xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics.g4dn.xlarge

  • stream.graphics.g4dn.2xlarge

  • stream.graphics.g4dn.4xlarge

  • stream.graphics.g4dn.8xlarge

  • stream.graphics.g4dn.12xlarge

  • stream.graphics.g4dn.16xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

VARCHAR
latest_appstream_agent_version

Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

VARCHAR
name

The name of the image builder.

VARCHAR
network_access_configuration

Describes the network details of the fleet or image builder instance.

STRUCT(
    "eni_private_ip_address" VARCHAR,
    "eni_id" VARCHAR
)
Show child fields
network_access_configuration.eni_id

The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

network_access_configuration.eni_private_ip_address

The private IP address of the elastic network interface that is attached to instances in your VPC.

platform

The operating system platform of the image builder.

VARCHAR
state

The state of the image builder.

VARCHAR
state_change_reason

The reason why the last state change occurred.

STRUCT(
    "code" VARCHAR,
    "message" VARCHAR
)
Show child fields
state_change_reason.code

The state change reason code.

state_change_reason.message

The state change reason message.

vpc_config

The VPC configuration of the image builder.

STRUCT(
    "subnet_ids" VARCHAR[],
    "security_group_ids" VARCHAR[]
)
Show child fields
vpc_config.security_group_ids[]
vpc_config.subnet_ids[]